protocol

Documentation

Overview

Package protocol implements the Debug protocol

Package protocol implements the Debug protocol

Package protocol implements the Debug protocol

Package protocol implements the Debug protocol

Package protocol implements the Debug protocol

Package protocol implements the Debug protocol

Package protocol implements the Debug protocol

Package protocol implements the Debug protocol

Index

• Constants
• type Protocol
  • func NewProtocol(server *nex.Server) *Protocol
  • func (protocol *Protocol) DisableAPIRecorder(handler func(err error, packet nex.PacketInterface, callID uint32) uint32)
  • func (protocol *Protocol) EnableAPIRecorder(handler func(err error, packet nex.PacketInterface, callID uint32) uint32)
  • func (protocol *Protocol) GetAPICallSummary(...)
  • func (protocol *Protocol) GetAPICalls(...)
  • func (protocol *Protocol) GetExcludeJoinedMatchmakeSession(...)
  • func (protocol *Protocol) HandlePacket(packet nex.PacketInterface)
  • func (protocol *Protocol) IsAPIRecorderEnabled(handler func(err error, packet nex.PacketInterface, callID uint32) uint32)
  • func (protocol *Protocol) SetExcludeJoinedMatchmakeSession(...)
  • func (protocol *Protocol) Setup()

Constants

const (
	// ProtocolID is the protocol ID for the Debug protocol
	ProtocolID = 0x74

	// MethodEnableAPIRecorder is the method ID for the method EnableAPIRecorder
	MethodEnableAPIRecorder = 0x1

	// MethodDisableAPIRecorder is the method ID for the method DisableAPIRecorder
	MethodDisableAPIRecorder = 0x2

	// MethodIsAPIRecorderEnabled is the method ID for the method IsAPIRecorderEnabled
	MethodIsAPIRecorderEnabled = 0x3

	// MethodGetAPICalls is the method ID for the method GetAPICalls
	MethodGetAPICalls = 0x4

	// MethodSetExcludeJoinedMatchmakeSession is the method ID for the method SetExcludeJoinedMatchmakeSession
	MethodSetExcludeJoinedMatchmakeSession = 0x5

	// MethodGetExcludeJoinedMatchmakeSession is the method ID for the method GetExcludeJoinedMatchmakeSession
	MethodGetExcludeJoinedMatchmakeSession = 0x6

	// MethodGetAPICallSummary is the method ID for the method GetAPICallSummary
	MethodGetAPICallSummary = 0x7
)

Types

type Protocol

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

Protocol handles the Debug protocol

func NewProtocol

func NewProtocol(server *nex.Server) *Protocol

NewProtocol returns a new Debug protocol

func (*Protocol) DisableAPIRecorder

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

DisableAPIRecorder sets the DisableAPIRecorder handler function

func (*Protocol) EnableAPIRecorder

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

EnableAPIRecorder sets the EnableAPIRecorder handler function

func (*Protocol) GetAPICallSummary

func (protocol *Protocol) GetAPICallSummary(handler func(err error, packet nex.PacketInterface, callID uint32, pakcetPayload []byte) uint32)

GetAPICallSummary sets the GetAPICallSummary handler function

func (*Protocol) GetAPICalls

func (protocol *Protocol) GetAPICalls(handler func(err error, packet nex.PacketInterface, callID uint32, pids []uint32, unknown *nex.DateTime, unknown2 *nex.DateTime) uint32)

GetAPICalls sets the GetAPICalls handler function

func (*Protocol) GetExcludeJoinedMatchmakeSession

func (protocol *Protocol) GetExcludeJoinedMatchmakeSession(handler func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) uint32)

GetExcludeJoinedMatchmakeSession sets the GetExcludeJoinedMatchmakeSession handler function

func (*Protocol) HandlePacket

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

HandlePacket sends the packet to the correct RMC method handler

func (*Protocol) IsAPIRecorderEnabled

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

IsAPIRecorderEnabled sets the IsAPIRecorderEnabled handler function

func (*Protocol) SetExcludeJoinedMatchmakeSession

func (protocol *Protocol) SetExcludeJoinedMatchmakeSession(handler func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) uint32)

SetExcludeJoinedMatchmakeSession sets the SetExcludeJoinedMatchmakeSession handler function

func (*Protocol) Setup

func (protocol *Protocol) Setup()

Setup initializes the protocol