packetbroker

Documentation

Overview

Package packetbroker abstracts the Packet Broker Agent to the upstream.Handler interface.

Index

• Constants
• type Cluster
• type Config
• type GatewayRegistry
• type Handler
  • func NewHandler(ctx context.Context, config Config) *Handler
  • func (h *Handler) ConnectGateway(ctx context.Context, ids *ttnpb.GatewayIdentifiers, conn *io.Connection) error
  • func (h *Handler) DevAddrPrefixes() []types.DevAddrPrefix
  • func (h *Handler) HandleStatus(context.Context, *ttnpb.GatewayIdentifiers, *ttnpb.GatewayStatus) error
  • func (h *Handler) HandleTxAck(context.Context, *ttnpb.GatewayIdentifiers, *ttnpb.TxAcknowledgment) error
  • func (h *Handler) HandleUplink(ctx context.Context, _ *ttnpb.GatewayIdentifiers, ...) error
  • func (h *Handler) Setup(context.Context) error

Constants

const (
	DefaultUpdateGatewayInterval = 10 * time.Minute
	DefaultUpdateGatewayJitter   = 0.2
	DefaultOnlineTTLMargin       = 10 * time.Second
)

Types

type Cluster

type Cluster interface {
	GetPeerConn(ctx context.Context, role ttnpb.ClusterRole, ids cluster.EntityIdentifiers) (*grpc.ClientConn, error)
	WithClusterAuth() grpc.CallOption
}

Cluster represents the interface the cluster.

type Config

type Config struct {
	UpdateInterval  time.Duration
	UpdateJitter    float64
	OnlineTTLMargin time.Duration
	DevAddrPrefixes []types.DevAddrPrefix
	GatewayRegistry GatewayRegistry
	Cluster         Cluster
}

Config configures the Handler.

type GatewayRegistry

type GatewayRegistry interface {
	Get(ctx context.Context, req *ttnpb.GetGatewayRequest) (*ttnpb.Gateway, error)
}

GatewayRegistry is a store with gateways.

type Handler

type Handler struct {
	Config
	// contains filtered or unexported fields
}

Handler is the upstream handler.

func NewHandler

func NewHandler(ctx context.Context, config Config) *Handler

NewHandler returns a new upstream handler.

func (*Handler) ConnectGateway

func (h *Handler) ConnectGateway(ctx context.Context, ids *ttnpb.GatewayIdentifiers, conn *io.Connection) error

ConnectGateway implements upstream.Handler.

func (*Handler) DevAddrPrefixes

func (h *Handler) DevAddrPrefixes() []types.DevAddrPrefix

DevAddrPrefixes implements upstream.Handler.

func (*Handler) HandleStatus

func (h *Handler) HandleStatus(context.Context, *ttnpb.GatewayIdentifiers, *ttnpb.GatewayStatus) error

HandleStatus implements upstream.Handler.

func (*Handler) HandleTxAck

func (h *Handler) HandleTxAck(context.Context, *ttnpb.GatewayIdentifiers, *ttnpb.TxAcknowledgment) error

HandleTxAck implements upstream.Handler.

func (*Handler) HandleUplink

func (h *Handler) HandleUplink(ctx context.Context, _ *ttnpb.GatewayIdentifiers, ids *ttnpb.EndDeviceIdentifiers, msg *ttnpb.GatewayUplinkMessage) error

HandleUplink implements upstream.Handler.

func (*Handler) Setup

func (h *Handler) Setup(context.Context) error

Setup implements upstream.Handler.