protocol

Documentation

Index

• type ExchangeFlag
  • func (flag ExchangeFlag) IsAcknowledgement() bool
  • func (flag ExchangeFlag) IsInitiator() bool
  • func (flag ExchangeFlag) IsReliability() bool
  • func (flag ExchangeFlag) IsSecuredExtension() bool
  • func (flag ExchangeFlag) IsVendor() bool
• type ExchangeID
• type Header
• type Opcode
• type ProtocolID
• type VenderID

Types

type ExchangeFlag

type ExchangeFlag uint8

ExchangeFlag represents a exchange flag.

func (ExchangeFlag) IsAcknowledgement

func (flag ExchangeFlag) IsAcknowledgement() bool

IsAcknowledgement returns true if the flag is acknowledgement.

func (ExchangeFlag) IsInitiator

func (flag ExchangeFlag) IsInitiator() bool

IsInitiator returns true if the flag is initiator.

func (ExchangeFlag) IsReliability

func (flag ExchangeFlag) IsReliability() bool

IsReliability returns true if the flag is reliability.

func (ExchangeFlag) IsSecuredExtension

func (flag ExchangeFlag) IsSecuredExtension() bool

IsSecuredExtension returns true if the flag is secured extension.

func (ExchangeFlag) IsVendor

func (flag ExchangeFlag) IsVendor() bool

IsVendor returns true if the flag is vendor.

type ExchangeID

type ExchangeID uint16

ExchangeID represents a exchange ID.

type Header

type Header struct {
	ExchangeFlag ExchangeFlag
	Opcode       Opcode
	ExchangeID   ExchangeID
	VenderID     VenderID
	ProtocolID   ProtocolID
}

4.4.3. Protocol Header Field Descriptions Header represents a protocol header.

type Opcode

type Opcode uint8

Opcode represents a message opcode.

const (
	StatusResponseMessage    Opcode = 0x01
	ReadRequestMessage       Opcode = 0x02
	SubscribeRequestMessage  Opcode = 0x03
	SubscribeResponseMessage Opcode = 0x04
	ReportDataMessage        Opcode = 0x05
	WriteRequestMessage      Opcode = 0x06
	WriteResponseMessage     Opcode = 0x07
	InvokeRequestMessage     Opcode = 0x08
	InvokeResponseMessage    Opcode = 0x09
	TimedRequestMessage      Opcode = 0x0A
)

type ProtocolID

type ProtocolID uint16

4.4.3.4. Protocol ID (16 bits) ProtocolID represents a protocol ID.

type VenderID

type VenderID uint16

4.4.3.5. Protocol Vendor ID (16 bits) VendorID represents a vendor ID.