protocol

package

v2.2.2 Latest Latest Go to latest Published: Oct 31, 2025 License: AGPL-3.0 Imports: 5 Imported by: 24

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/PretendoNetwork/nex-protocols-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package protocol implements the Ticket Granting protocol

Package protocol implements the Ticket Granting protocol ¶

Package protocol implements the Ticket Granting protocol

Constants ¶

View Source

const (
	// ProtocolID is the protocol ID for the Ticket Granting protocol
	ProtocolID = 0xA

	// MethodLogin is the method ID for the method Login
	MethodLogin = 0x1

	// MethodLoginEx is the method ID for the method LoginEx
	MethodLoginEx = 0x2

	// MethodRequestTicket is the method ID for the method RequestTicket
	MethodRequestTicket = 0x3

	// MethodGetPID is the method ID for the method GetPID
	MethodGetPID = 0x4

	// MethodGetName is the method ID for the method GetName
	MethodGetName = 0x5

	// MethodLoginWithContext is the method ID for the method LoginWithContext
	MethodLoginWithContext = 0x6
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Interface ¶

type Interface interface {
	Endpoint() nex.EndpointInterface
	SetEndpoint(endpoint nex.EndpointInterface)
	SetHandlerLogin(handler func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String) (*nex.RMCMessage, *nex.Error))
	SetHandlerLoginEx(handler func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String, oExtraData types.DataHolder) (*nex.RMCMessage, *nex.Error))
	SetHandlerRequestTicket(handler func(err error, packet nex.PacketInterface, callID uint32, idSource types.PID, idTarget types.PID) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetPID(handler func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetName(handler func(err error, packet nex.PacketInterface, callID uint32, id types.PID) (*nex.RMCMessage, *nex.Error))
	SetHandlerLoginWithContext(handler func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error))
}

Interface implements the methods present on the Ticket Granting protocol struct

type Protocol ¶

type Protocol struct {
	Login            func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String) (*nex.RMCMessage, *nex.Error)
	LoginEx          func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String, oExtraData types.DataHolder) (*nex.RMCMessage, *nex.Error)
	RequestTicket    func(err error, packet nex.PacketInterface, callID uint32, idSource types.PID, idTarget types.PID) (*nex.RMCMessage, *nex.Error)
	GetPID           func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String) (*nex.RMCMessage, *nex.Error)
	GetName          func(err error, packet nex.PacketInterface, callID uint32, id types.PID) (*nex.RMCMessage, *nex.Error)
	LoginWithContext func(err error, packet nex.PacketInterface, callID uint32) (*nex.RMCMessage, *nex.Error)
	Patches          nex.ServiceProtocol
	PatchedMethods   []uint32
	// contains filtered or unexported fields
}

Protocol stores all the RMC method handlers for the Ticket Granting protocol and listens for requests

func NewProtocol ¶

func NewProtocol() *Protocol

NewProtocol returns a new Ticket Granting 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) SetHandlerGetName ¶

func (protocol *Protocol) SetHandlerGetName(handler func(err error, packet nex.PacketInterface, callID uint32, id types.PID) (*nex.RMCMessage, *nex.Error))

SetHandlerGetName sets the handler for the GetName method

func (*Protocol) SetHandlerGetPID ¶

func (protocol *Protocol) SetHandlerGetPID(handler func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String) (*nex.RMCMessage, *nex.Error))

SetHandlerGetPID sets the handler for the GetPID method

func (*Protocol) SetHandlerLogin ¶

func (protocol *Protocol) SetHandlerLogin(handler func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String) (*nex.RMCMessage, *nex.Error))

SetHandlerLogin sets the handler for the Login method

func (*Protocol) SetHandlerLoginEx ¶

func (protocol *Protocol) SetHandlerLoginEx(handler func(err error, packet nex.PacketInterface, callID uint32, strUserName types.String, oExtraData types.DataHolder) (*nex.RMCMessage, *nex.Error))

SetHandlerLoginEx sets the handler for the LoginEx method

func (*Protocol) SetHandlerLoginWithContext ¶

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

SetHandlerLoginWithContext sets the handler for the LoginWithContext method

func (*Protocol) SetHandlerRequestTicket ¶

func (protocol *Protocol) SetHandlerRequestTicket(handler func(err error, packet nex.PacketInterface, callID uint32, idSource types.PID, idTarget types.PID) (*nex.RMCMessage, *nex.Error))

SetHandlerRequestTicket sets the handler for the RequestTicket method

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
types Package types implements all the types used by the TicketGranting protocol	Package types implements all the types used by the TicketGranting protocol

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL