protocol

Documentation

Overview

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Package protocol implements the Secure Connection protocol

Index

• Constants
• type Protocol
  • func NewProtocol(server *nex.Server) *Protocol
  • func (protocol *Protocol) HandlePacket(packet nex.PacketInterface)
  • func (protocol *Protocol) Register(handler func(err error, packet nex.PacketInterface, callID uint32, ...) uint32)
  • func (protocol *Protocol) RegisterEx(handler func(err error, packet nex.PacketInterface, callID uint32, ...) uint32)
  • func (protocol *Protocol) ReplaceURL(...)
  • func (protocol *Protocol) RequestConnectionData(...)
  • func (protocol *Protocol) RequestURLs(...)
  • func (protocol *Protocol) SendReport(...)
  • func (protocol *Protocol) Setup()
  • func (protocol *Protocol) TestConnectivity(handler func(err error, packet nex.PacketInterface, callID uint32) uint32)
  • func (protocol *Protocol) UpdateURLs(handler func(err error, packet nex.PacketInterface, callID uint32, ...) uint32)

Constants

const (
	// ProtocolID is the protocol ID for the Secure Connection protocol
	ProtocolID = 0xB

	// MethodRegister is the method ID for the method Register
	MethodRegister = 0x1

	// MethodRequestConnectionData is the method ID for the method RequestConnectionData
	MethodRequestConnectionData = 0x2

	// MethodRequestURLs is the method ID for the method RequestURLs
	MethodRequestURLs = 0x3

	// MethodRegisterEx is the method ID for the method RegisterEx
	MethodRegisterEx = 0x4

	// MethodTestConnectivity is the method ID for the method TestConnectivity
	MethodTestConnectivity = 0x5

	// MethodUpdateURLs is the method ID for the method UpdateURLs
	MethodUpdateURLs = 0x6

	// MethodReplaceURL is the method ID for the method ReplaceURL
	MethodReplaceURL = 0x7

	// MethodSendReport is the method ID for the method SendReport
	MethodSendReport = 0x8
)

Types

type Protocol

type Protocol struct {
	Server *nex.Server
	// contains filtered or unexported fields
}

Protocol stores all the RMC method handlers for the Secure Connection protocol and listens for requests

func NewProtocol

func NewProtocol(server *nex.Server) *Protocol

NewProtocol returns a new Secure Connection protocol

func (*Protocol) HandlePacket

func (protocol *Protocol) HandlePacket(packet nex.PacketInterface)

HandlePacket sends the packet to the correct RMC method handler

func (*Protocol) Register

func (protocol *Protocol) Register(handler func(err error, packet nex.PacketInterface, callID uint32, vecMyURLs []*nex.StationURL) uint32)

Register sets the Register handler function

func (*Protocol) RegisterEx

func (protocol *Protocol) RegisterEx(handler func(err error, packet nex.PacketInterface, callID uint32, vecMyURLs []*nex.StationURL, hCustomData *nex.DataHolder) uint32)

RegisterEx sets the RegisterEx handler function

func (*Protocol) ReplaceURL

func (protocol *Protocol) ReplaceURL(handler func(err error, packet nex.PacketInterface, callID uint32, target *nex.StationURL, url *nex.StationURL) uint32)

ReplaceURL sets the ReplaceURL handler function

func (*Protocol) RequestConnectionData

func (protocol *Protocol) RequestConnectionData(handler func(err error, packet nex.PacketInterface, callID uint32, cidTarget uint32, pidTarget uint32) uint32)

RequestConnectionData sets the RequestConnectionData handler function

func (*Protocol) RequestURLs

func (protocol *Protocol) RequestURLs(handler func(err error, packet nex.PacketInterface, callID uint32, cidTarget uint32, pidTarget uint32) uint32)

RequestURLs sets the RequestURLs handler function

func (*Protocol) SendReport

func (protocol *Protocol) SendReport(handler func(err error, packet nex.PacketInterface, callID uint32, reportID uint32, reportData []byte) uint32)

SendReport sets the SendReport handler function

func (*Protocol) Setup

func (protocol *Protocol) Setup()

Setup initializes the protocol

func (*Protocol) TestConnectivity

func (protocol *Protocol) TestConnectivity(handler func(err error, packet nex.PacketInterface, callID uint32) uint32)

TestConnectivity sets the TestConnectivity handler function

func (*Protocol) UpdateURLs

func (protocol *Protocol) UpdateURLs(handler func(err error, packet nex.PacketInterface, callID uint32, vecMyURLs []*nex.StationURL) uint32)

UpdateURLs sets the UpdateURLs handler function