messageprocessors

Documentation

Overview

Package messageprocessors provides interfaces and implementations for processing uplink and downlink messages.

Index

• type CompilablePayloadEncoderDecoder
• type MapPayloadProcessor
  • func (p MapPayloadProcessor) DecodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, ...) error
  • func (p MapPayloadProcessor) DecodeUplink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, ...) error
  • func (p MapPayloadProcessor) EncodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, ...) error
  • func (p MapPayloadProcessor) GetPayloadEncoderDecoder(ctx context.Context, formatter ttnpb.PayloadFormatter) (PayloadEncoderDecoder, error)
• type PayloadEncoderDecoder
• type PayloadProcessor

Types

type CompilablePayloadEncoderDecoder

type CompilablePayloadEncoderDecoder interface {
	PayloadEncoderDecoder

	CompileDownlinkEncoder(ctx context.Context, parameter string) (func(context.Context, *ttnpb.EndDeviceIdentifiers, *ttnpb.EndDeviceVersionIdentifiers, *ttnpb.ApplicationDownlink) error, error)
	CompileUplinkDecoder(ctx context.Context, parameter string) (func(context.Context, *ttnpb.EndDeviceIdentifiers, *ttnpb.EndDeviceVersionIdentifiers, *ttnpb.ApplicationUplink) error, error)
	CompileDownlinkDecoder(ctx context.Context, parameter string) (func(context.Context, *ttnpb.EndDeviceIdentifiers, *ttnpb.EndDeviceVersionIdentifiers, *ttnpb.ApplicationDownlink) error, error)
}

CompilablePayloadEncoderDecoder extends PayloadEncoderDecoder with the ability to compile the parameters ahead of time.

type MapPayloadProcessor

type MapPayloadProcessor map[ttnpb.PayloadFormatter]PayloadEncoderDecoder

MapPayloadProcessor implements PayloadProcessor using a mapping between ttnpb.PayloadFormatter and PayloadEncoderDecoder.

func (MapPayloadProcessor) DecodeDownlink

func (p MapPayloadProcessor) DecodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, msg *ttnpb.ApplicationDownlink, formatter ttnpb.PayloadFormatter, parameter string) error

DecodeDownlink implements PayloadProcessor.

func (MapPayloadProcessor) DecodeUplink

func (p MapPayloadProcessor) DecodeUplink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, msg *ttnpb.ApplicationUplink, formatter ttnpb.PayloadFormatter, parameter string) error

DecodeUplink implements PayloadProcessor.

func (MapPayloadProcessor) EncodeDownlink

func (p MapPayloadProcessor) EncodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, msg *ttnpb.ApplicationDownlink, formatter ttnpb.PayloadFormatter, parameter string) error

EncodeDownlink implements PayloadProcessor.

func (MapPayloadProcessor) GetPayloadEncoderDecoder

func (p MapPayloadProcessor) GetPayloadEncoderDecoder(ctx context.Context, formatter ttnpb.PayloadFormatter) (PayloadEncoderDecoder, error)

GetPayloadEncoderDecoder returns the underlying PayloadEncoderDecoder for the provided format.

type PayloadEncoderDecoder

type PayloadEncoderDecoder interface {
	EncodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, message *ttnpb.ApplicationDownlink, parameter string) error
	DecodeUplink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, message *ttnpb.ApplicationUplink, parameter string) error
	DecodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, message *ttnpb.ApplicationDownlink, parameter string) error
}

PayloadEncoderDecoder provides an interface to encoding and decoding messages.

type PayloadProcessor

type PayloadProcessor interface {
	EncodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, message *ttnpb.ApplicationDownlink, formatter ttnpb.PayloadFormatter, parameter string) error
	DecodeUplink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, message *ttnpb.ApplicationUplink, formatter ttnpb.PayloadFormatter, parameter string) error
	DecodeDownlink(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, version *ttnpb.EndDeviceVersionIdentifiers, message *ttnpb.ApplicationDownlink, formatter ttnpb.PayloadFormatter, parameter string) error
}

PayloadProcessor provides an interface to processing payloads of multiple formats.