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 Interface
• type Protocol
  • func NewProtocol() *Protocol
  • func (protocol *Protocol) Endpoint() nex.EndpointInterface
  • func (protocol *Protocol) HandlePacket(packet nex.PacketInterface)
  • func (protocol *Protocol) SetEndpoint(endpoint nex.EndpointInterface)
  • func (protocol *Protocol) SetHandlerDisableAPIRecorder(...)
  • func (protocol *Protocol) SetHandlerEnableAPIRecorder(...)
  • func (protocol *Protocol) SetHandlerGetAPICallSummary(...)
  • func (protocol *Protocol) SetHandlerGetAPICalls(...)
  • func (protocol *Protocol) SetHandlerGetExcludeJoinedMatchmakeSession(...)
  • func (protocol *Protocol) SetHandlerIsAPIRecorderEnabled(...)
  • func (protocol *Protocol) SetHandlerSetExcludeJoinedMatchmakeSession(...)

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 Interface

type Interface interface {
	Endpoint() nex.EndpointInterface
	SetEndpoint(endpoint nex.EndpointInterface)
	SetHandlerEnableAPIRecorder(handler func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error))
	SetHandlerDisableAPIRecorder(handler func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error))
	SetHandlerIsAPIRecorderEnabled(handler func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetAPICalls(handler func(err error, packet nex.PacketInterface, callID uint32, pids *types.List[*types.PID], unknown *types.DateTime, unknown2 *types.DateTime) (*nex.RMCMessage, *nex.Error))
	SetHandlerSetExcludeJoinedMatchmakeSession(handler func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetExcludeJoinedMatchmakeSession(handler func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetAPICallSummary(handler func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) (*nex.RMCMessage, *nex.Error))
}

Interface implements the methods present on the Debug protocol struct

type Protocol

type Protocol struct {
	EnableAPIRecorder                func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error)
	DisableAPIRecorder               func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error)
	IsAPIRecorderEnabled             func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error)
	GetAPICalls                      func(err error, packet nex.PacketInterface, callID uint32, pids *types.List[*types.PID], unknown *types.DateTime, unknown2 *types.DateTime) (*nex.RMCMessage, *nex.Error)
	SetExcludeJoinedMatchmakeSession func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) (*nex.RMCMessage, *nex.Error) // TODO - Unknown request/response format
	GetExcludeJoinedMatchmakeSession func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) (*nex.RMCMessage, *nex.Error) // TODO - Unknown request/response format
	GetAPICallSummary                func(err error, packet nex.PacketInterface, callID uint32, packetPayload []byte) (*nex.RMCMessage, *nex.Error) // TODO - Unknown request/response format
	Patches                          nex.ServiceProtocol
	PatchedMethods                   []uint32
	// contains filtered or unexported fields
}

Protocol handles the Debug protocol

func NewProtocol

func NewProtocol() *Protocol

NewProtocol returns a new Debug protocol

func (*Protocol) Endpoint

func (protocol *Protocol) Endpoint() nex.EndpointInterface

Endpoint returns the endpoint implementing the protocol

func (*Protocol) HandlePacket

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

HandlePacket sends the packet to the correct RMC method handler

func (*Protocol) SetEndpoint

func (protocol *Protocol) SetEndpoint(endpoint nex.EndpointInterface)

SetEndpoint sets the endpoint implementing the protocol

func (*Protocol) SetHandlerDisableAPIRecorder

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

SetHandlerDisableAPIRecorder sets the handler for the DisableAPIRecorder method

func (*Protocol) SetHandlerEnableAPIRecorder

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

SetHandlerEnableAPIRecorder sets the handler for the EnableAPIRecorder method

func (*Protocol) SetHandlerGetAPICallSummary

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

SetHandlerGetAPICallSummary sets the handler for the GetAPICallSummary method

func (*Protocol) SetHandlerGetAPICalls

func (protocol *Protocol) SetHandlerGetAPICalls(handler func(err error, packet nex.PacketInterface, callID uint32, pids *types.List[*types.PID], unknown *types.DateTime, unknown2 *types.DateTime) (*nex.RMCMessage, *nex.Error))

SetHandlerGetAPICalls sets the handler for the GetAPICalls method

func (*Protocol) SetHandlerGetExcludeJoinedMatchmakeSession

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

SetHandlerGetExcludeJoinedMatchmakeSession sets the handler for the GetExcludeJoinedMatchmakeSession method

func (*Protocol) SetHandlerIsAPIRecorderEnabled

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

SetHandlerIsAPIRecorderEnabled sets the handler for the IsAPIRecorderEnabled method

func (*Protocol) SetHandlerSetExcludeJoinedMatchmakeSession

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

SetHandlerSetExcludeJoinedMatchmakeSession sets the handler for the SetExcludeJoinedMatchmakeSession method