apitools

Documentation

Index

• func ContextWithAuth(token string) context.Context
• func ContextWithAuthAndTimeout(token string, timeout time.Duration) (context.Context, func())
• type DataStream
  • func NewCollectionDataStream(ctx context.Context, config *spanapi.Configuration, collectionID string) (DataStream, error)
  • func NewDeviceDataStream(ctx context.Context, config *spanapi.Configuration, ...) (DataStream, error)

Functions

func ContextWithAuth

func ContextWithAuth(token string) context.Context

ContextWithAuth returns a context with the API token set

func ContextWithAuthAndTimeout

func ContextWithAuthAndTimeout(token string, timeout time.Duration) (context.Context, func())

ContextWithAuthAndTimeout returns a context with the API token set and timeout

Types

type DataStream

type DataStream interface {
	Recv() (spanapi.OutputDataMessage, error)
	Close() error
}

DataStream is a stream of data from the Span service. The data stream uses a websocket under the hood.

func NewCollectionDataStream

func NewCollectionDataStream(ctx context.Context, config *spanapi.Configuration, collectionID string) (DataStream, error)

NewCollectionDataStream creates a live data stream for devices in a collection. The context must contain the appropriate credentials.

func NewDeviceDataStream

func NewDeviceDataStream(ctx context.Context, config *spanapi.Configuration, collectionID, deviceID string) (DataStream, error)

NewDeviceDataStream creates a live data stream for a single device. The context must contain the appropriate credentials.