transport

Documentation

Index

• type Credentials
• type MessageDispatcher
• type MethodDispatcher
• type Transport
• type TwinStateDispatcher

Types

type Credentials

type Credentials interface {
	GetDeviceID() string
	GetHostName() string
	GetCertificate() *tls.Certificate
	Token(resource string, lifetime time.Duration) (*common.SharedAccessSignature, error)
	TokenFromEdge(workloadURI, module, genid, resource string, lifetime time.Duration) (*common.SharedAccessSignature, error)
	GetSAK() string
	GetModuleID() string
	GetGenerationID() string
	GetGateway() string
	GetBroker() string
	GetWorkloadURI() string
	UseEdgeGateway() bool
}

Credentials interface.

type MessageDispatcher

type MessageDispatcher interface {
	Dispatch(msg *common.Message)
}

MessageDispatcher handles incoming messages.

type MethodDispatcher

type MethodDispatcher interface {
	Dispatch(methodName string, b []byte) (rc int, data []byte, err error)
}

MethodDispatcher handles direct method calls.

type Transport

type Transport interface {
	SetLogger(logger logger.Logger)
	Connect(ctx context.Context, creds Credentials) error
	Send(ctx context.Context, msg *common.Message) error
	RegisterDirectMethods(ctx context.Context, mux MethodDispatcher) error
	SubscribeEvents(ctx context.Context, mux MessageDispatcher) error
	SubscribeTwinUpdates(ctx context.Context, mux TwinStateDispatcher) error
	RetrieveTwinProperties(ctx context.Context) (payload []byte, err error)
	UpdateTwinProperties(ctx context.Context, payload []byte) (version int, err error)
	GetBlobSharedAccessSignature(ctx context.Context, blobName string) (string, string, error)
	UploadToBlob(ctx context.Context, sasURI string, file io.Reader, size int64) error
	NotifyUploadComplete(ctx context.Context, correlationID string, success bool, statusCode int, statusDescription string) error
	ListModules(ctx context.Context) ([]*iotservice.Module, error)
	CreateModule(ctx context.Context, module *iotservice.Module) (*iotservice.Module, error)
	GetModule(ctx context.Context, moduleID string) (*iotservice.Module, error)
	UpdateModule(ctx context.Context, module *iotservice.Module) (*iotservice.Module, error)
	DeleteModule(ctx context.Context, module *iotservice.Module) error
	Close() error
}

Transport interface.

type TwinStateDispatcher

type TwinStateDispatcher interface {
	Dispatch(b []byte)
}

TwinStateDispatcher handles twin state updates.