common

Documentation

Index

• func ParseConnectionString(cs string, require ...string) (map[string]string, error)
• func RootCAs() *x509.CertPool
• type ConnectionAuthMethod
• type LevelLogger
  • func NewLogger(name string, lvl LogLevel, print PrintFunc) *LevelLogger
  • func NewLoggerFromEnv(name, key string) *LevelLogger
  • func (l *LevelLogger) Debugf(format string, v ...interface{})
  • func (l *LevelLogger) Errorf(format string, v ...interface{})
  • func (l *LevelLogger) Infof(format string, v ...interface{})
  • func (l *LevelLogger) Warnf(format string, v ...interface{})
• type LogLevel
  • func (lvl LogLevel) String() string
• type Logger
• type Message
• type PrintFunc
• type SharedAccessKey
  • func NewSharedAccessKey(hostname, policy, key string) *SharedAccessKey
  • func (c *SharedAccessKey) Token(resource string, lifetime time.Duration) (*SharedAccessSignature, error)
• type SharedAccessSignature
  • func NewSharedAccessSignature(resource, policy, key string, expiry time.Time) (*SharedAccessSignature, error)
  • func (sas *SharedAccessSignature) String() string

Functions

func ParseConnectionString

func ParseConnectionString(cs string, require ...string) (map[string]string, error)

ParseConnectionString parses the given connection string into a key-value map, returns an error if at least one of required keys is missing.

func RootCAs

func RootCAs() *x509.CertPool

RootCAs root CA certificates pool for connecting to the cloud.

Types

type ConnectionAuthMethod

type ConnectionAuthMethod struct {
	Scope  string `json:"scope"`
	Type   string `json:"type"`
	Issuer string `json:"issuer"`
}

ConnectionAuthMethod is an authentication method of device-to-cloud communication.

type LevelLogger

type LevelLogger struct {
	// contains filtered or unexported fields
}

LevelLogger is a logger that supports log levels.

func NewLogger

func NewLogger(name string, lvl LogLevel, print PrintFunc) *LevelLogger

NewLogger creates a new leveled logger instance with the given parameters.

func NewLoggerFromEnv

func NewLoggerFromEnv(name, key string) *LevelLogger

NewLoggerFromEnv returns a LevelLogger with the name prefix and severity based on the named environment variable or it falls back to LevelWarn if it's missing.

It uses the standard log.Print function for output so it can be controlled via the exposed configuration methods.

func (*LevelLogger) Debugf

func (l *LevelLogger) Debugf(format string, v ...interface{})

func (*LevelLogger) Errorf

func (l *LevelLogger) Errorf(format string, v ...interface{})

func (*LevelLogger) Infof

func (l *LevelLogger) Infof(format string, v ...interface{})

func (*LevelLogger) Warnf

func (l *LevelLogger) Warnf(format string, v ...interface{})

type LogLevel

type LogLevel uint8

LogLevel is logging severity.

const (
	LevelError LogLevel = iota
	LevelWarn
	LevelInfo
	LevelDebug
)

func (LogLevel) String

func (lvl LogLevel) String() string

String returns log level string representation.

type Logger

type Logger interface {
	Errorf(format string, v ...interface{})
	Warnf(format string, v ...interface{})
	Infof(format string, v ...interface{})
	Debugf(format string, v ...interface{})
}

Logger is common logging interface.

type Message

type Message struct {
	// MessageID is a user-settable identifier for the message used for request-reply patterns.
	MessageID string `json:"MessageId,omitempty"`

	// To is a destination specified in cloud-to-device messages.
	To string `json:"To,omitempty"`

	// ExpiryTime is time of message expiration.
	ExpiryTime *time.Time `json:"ExpiryTimeUtc,omitempty"`

	// EnqueuedTime is time the Cloud-to-Device message was received by IoT Hub.
	EnqueuedTime *time.Time `json:"EnqueuedTime,omitempty"`

	// CorrelationID is a string property in a response message that typically
	// contains the MessageId of the request, in request-reply patterns.
	CorrelationID string `json:"CorrelationId,omitempty"`

	// UserID is an ID used to specify the origin of messages.
	UserID string `json:"UserId,omitempty"`

	// ConnectionDeviceID is an ID set by IoT Hub on device-to-cloud messages.
	// It contains the deviceId of the device that sent the message.
	ConnectionDeviceID string `json:"ConnectionDeviceId,omitempty"`

	// ConnectionDeviceGenerationID is an ID set by IoT Hub on device-to-cloud messages.
	// It contains the generationId (as per Device identity properties)
	// of the device that sent the message.
	ConnectionDeviceGenerationID string `json:"ConnectionDeviceGenerationId,omitempty"`

	// ConnectionAuthMethod is an authentication method set by IoT Hub on
	// device-to-cloud messages. This property contains information about
	// the authentication method used to authenticate the device sending the message.
	ConnectionAuthMethod *ConnectionAuthMethod `json:"ConnectionAuthMethod,omitempty"`

	// MessageSource determines a device-to-cloud message transport.
	MessageSource string `json:"MessageSource,omitempty"`

	// Payload is message data.
	Payload []byte `json:"Payload,omitempty"`

	// Properties are custom message properties (property bags).
	Properties map[string]string `json:"Properties,omitempty"`

	// TransportOptions transport specific options.
	TransportOptions map[string]interface{} `json:"-"`
}

Message is a common message format for all device-facing protocols. This message format is used for both device-to-cloud and cloud-to-device messages. See: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-construct

type PrintFunc

type PrintFunc func(v ...interface{})

PrintFunc is used for writing logs that works as fmt.Print.

type SharedAccessKey

type SharedAccessKey struct {
	HostName            string
	SharedAccessKeyName string
	SharedAccessKey     string
}

SharedAccessKey is SAS token generator.

func NewSharedAccessKey

func NewSharedAccessKey(hostname, policy, key string) *SharedAccessKey

NewSharedAccessKey creates new shared access key for subsequent token generation.

func (*SharedAccessKey) Token

func (c *SharedAccessKey) Token(
	resource string, lifetime time.Duration,
) (*SharedAccessSignature, error)

Token generates a shared access signature for the named resource and lifetime.

type SharedAccessSignature

type SharedAccessSignature struct {
	Sr  string
	Sig string
	Se  time.Time
	Skn string
}

SharedAccessSignature is a shared access signature instance.

func NewSharedAccessSignature

func NewSharedAccessSignature(
	resource, policy, key string, expiry time.Time,
) (*SharedAccessSignature, error)

NewSharedAccessSignature initialized a new shared access signature and generates signature fields based on the given input.

func (*SharedAccessSignature) String

func (sas *SharedAccessSignature) String() string

String converts the signature to a token string.