gateway

type Gateway struct {
	ID          string
	Status      StatusStore
	Utilization Utilization
	Schedule    Schedule
	LastSeen    time.Time

	Monitors pb_monitor.Registry

	Ctx log.Interface
	// contains filtered or unexported fields
}

type Schedule interface {
	fmt.GoStringer
	// Synchronize the schedule with the gateway timestamp (in microseconds)
	Sync(timestamp uint32)
	// Get an "option" on a transmission slot at timestamp for the maximum duration of length (both in microseconds)
	GetOption(timestamp uint32, length uint32) (id string, score uint)
	// Schedule a transmission on a slot
	Schedule(id string, downlink *router_pb.DownlinkMessage) error
	// Subscribe to downlink messages
	Subscribe(subscriptionID string) <-chan *router_pb.DownlinkMessage
	// Whether the gateway has active downlink
	IsActive() bool
	// Stop the subscription
	Stop(subscriptionID string)
}

type StatusStore interface {
	// Insert or Update the status
	Update(status *pb_gateway.Status) error
	// Get the last status
	Get() (*pb_gateway.Status, error)
}

type Utilization interface {
	fmt.GoStringer
	// AddRx updates the utilization for receiving an uplink message
	AddRx(uplink *pb_router.UplinkMessage) error
	// AddRx updates the utilization for transmitting a downlink message
	AddTx(downlink *pb_router.DownlinkMessage) error
	// Get returns the overall rx and tx utilization for the gateway. If the gateway has multiple channels, the values will be 0 <= value < numChannels
	Get() (rx float64, tx float64)
	// GetChannel returns the rx and tx utilization for the given channel. The values will be 0 <= value < 1
	GetChannel(frequency uint64) (rx float64, tx float64)
	// Tick the clock to update the moving average. It should be called every 5 seconds
	Tick()
}