source

Documentation

Index

• func FlagSet() *pflag.FlagSet
• func RegisterSource(r Registration) error
• func Sources() map[string]string
• type CreateSource
• type Registration
• type Source
  • func NewSource(ctx context.Context, flags *pflag.FlagSet) (Source, error)

Functions

func FlagSet

func FlagSet() *pflag.FlagSet

FlagSet returns flags for all configured sources.

func RegisterSource

func RegisterSource(r Registration) error

RegisterSource registers a new Source.

func Sources

func Sources() map[string]string

Sources returns a map of registered Sources and their descriptions.

Types

type CreateSource

type CreateSource func(ctx context.Context, flags *pflag.FlagSet) (Source, error)

CreateSource is a function that constructs a new Source.

type Registration

type Registration struct {
	Name,
	Description string

	Create  CreateSource
	FlagSet *pflag.FlagSet
}

Registration contains information for a registered Source.

type Source

type Source interface {
	// ExportDevice retrieves an end device from the source and returns it as a ttnpb.EndDevice.
	ExportDevice(devID string) (*ttnpb.EndDevice, error)
	// RangeDevices calls a function for all matching devices of an application.
	RangeDevices(appID string, f func(s Source, devID string) error) error
	// Close cleans up and terminates any open connections.
	Close() error
}

Source is a source for end devices.

func NewSource

func NewSource(ctx context.Context, flags *pflag.FlagSet) (Source, error)

NewSource creates a new Source from parsed flags.