protocol

package

v2.0.3 Latest Latest Go to latest Published: May 19, 2024 License: AGPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/PretendoNetwork/nex-protocols-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package protocol implements the Friends QRV protocol

Package protocol implements the Friends QRV protocol ¶

Package protocol implements the Friends QRV protocol

Constants ¶

View Source

const (
	// ProtocolID is the protocol ID for the Friends protocol
	ProtocolID = 0x14

	// MethodAddFriend is the method ID for method AddFriend
	MethodAddFriend = 0x1

	// MethodAddFriendByName is the method ID for method AddFriendByName
	MethodAddFriendByName = 0x2

	// MethodAddFriendWithDetails is the method ID for method AddFriendWithDetails
	MethodAddFriendWithDetails = 0x3

	// MethodAddFriendByNameWithDetails is the method ID for method AddFriendByNameWithDetails
	MethodAddFriendByNameWithDetails = 0x4

	// MethodAcceptFriendship is the method ID for method AcceptFriendship
	MethodAcceptFriendship = 0x5

	// MethodDeclineFriendship is the method ID for method DeclineFriendship
	MethodDeclineFriendship = 0x6

	// MethodBlackList is the method ID for method BlackList
	MethodBlackList = 0x7

	// MethodBlackListByName is the method ID for method BlackListByName
	MethodBlackListByName = 0x8

	// MethodClearRelationship is the method ID for method ClearRelationship
	MethodClearRelationship = 0x9

	// MethodUpdateDetails is the method ID for method UpdateDetails
	MethodUpdateDetails = 0xA

	// MethodGetList is the method ID for method GetList
	MethodGetList = 0xB

	// MethodGetDetailedList is the method ID for method GetDetailedList
	MethodGetDetailedList = 0xC

	// MethodGetRelationships is the method ID for method GetRelationships
	MethodGetRelationships = 0xD
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Interface ¶

type Interface interface {
	Endpoint() nex.EndpointInterface
	SetEndpoint(endpoint nex.EndpointInterface)
	SetHandlerAddFriend(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))
	SetHandlerAddFriendByName(handler func(err error, packet nex.PacketInterface, callID uint32, strPlayerName *types.String, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))
	SetHandlerAddFriendWithDetails(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))
	SetHandlerAddFriendByNameWithDetails(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))
	SetHandlerAcceptFriendship(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))
	SetHandlerDeclineFriendship(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))
	SetHandlerBlackList(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))
	SetHandlerBlackListByName(handler func(err error, packet nex.PacketInterface, callID uint32, strPlayerName *types.String, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))
	SetHandlerClearRelationship(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))
	SetHandlerUpdateDetails(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetList(handler func(err error, packet nex.PacketInterface, callID uint32, byRelationship *types.PrimitiveU8, bReversed *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetDetailedList(handler func(err error, packet nex.PacketInterface, callID uint32, byRelationship *types.PrimitiveU8, bReversed *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetRelationships(handler func(err error, packet nex.PacketInterface, callID uint32, resultRange *types.ResultRange) (*nex.RMCMessage, *nex.Error))
}

Interface implements the methods present on the Friends protocol struct

type Protocol ¶

type Protocol struct {
	AddFriend                  func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error)
	AddFriendByName            func(err error, packet nex.PacketInterface, callID uint32, strPlayerName *types.String, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error)
	AddFriendWithDetails       func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error)
	AddFriendByNameWithDetails func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error) // TODO - Is this the right signature?
	AcceptFriendship           func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error)
	DeclineFriendship          func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error)
	BlackList                  func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error)
	BlackListByName            func(err error, packet nex.PacketInterface, callID uint32, strPlayerName *types.String, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error)
	ClearRelationship          func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error)
	UpdateDetails              func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error)
	GetList                    func(err error, packet nex.PacketInterface, callID uint32, byRelationship *types.PrimitiveU8, bReversed *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	GetDetailedList            func(err error, packet nex.PacketInterface, callID uint32, byRelationship *types.PrimitiveU8, bReversed *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	GetRelationships           func(err error, packet nex.PacketInterface, callID uint32, resultRange *types.ResultRange) (*nex.RMCMessage, *nex.Error)
	Patches                    nex.ServiceProtocol
	PatchedMethods             []uint32
	// contains filtered or unexported fields
}

Protocol handles the Friends QRV protocol

func NewProtocol ¶

func NewProtocol() *Protocol

NewProtocol returns a new Friends 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) SetHandlerAcceptFriendship ¶

func (protocol *Protocol) SetHandlerAcceptFriendship(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))

SetHandlerAcceptFriendship sets the handler for the AcceptFriendship method

func (*Protocol) SetHandlerAddFriend ¶

func (protocol *Protocol) SetHandlerAddFriend(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))

SetHandlerAddFriend sets the handler for the AddFriend method

func (*Protocol) SetHandlerAddFriendByName ¶

func (protocol *Protocol) SetHandlerAddFriendByName(handler func(err error, packet nex.PacketInterface, callID uint32, strPlayerName *types.String, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))

SetHandlerAddFriendByName sets the handler for the AddFriendByName method

func (*Protocol) SetHandlerAddFriendByNameWithDetails ¶

func (protocol *Protocol) SetHandlerAddFriendByNameWithDetails(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))

SetHandlerAddFriendByNameWithDetails sets the handler for the AddFriendByNameWithDetails method

func (*Protocol) SetHandlerAddFriendWithDetails ¶

func (protocol *Protocol) SetHandlerAddFriendWithDetails(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32, strMessage *types.String) (*nex.RMCMessage, *nex.Error))

SetHandlerAddFriendWithDetails sets the handler for the AddFriendWithDetails method

func (*Protocol) SetHandlerBlackList ¶

func (protocol *Protocol) SetHandlerBlackList(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))

SetHandlerBlackList sets the handler for the BlackList method

func (*Protocol) SetHandlerBlackListByName ¶

func (protocol *Protocol) SetHandlerBlackListByName(handler func(err error, packet nex.PacketInterface, callID uint32, strPlayerName *types.String, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))

SetHandlerBlackListByName sets the handler for the BlackListByName method

func (*Protocol) SetHandlerClearRelationship ¶

func (protocol *Protocol) SetHandlerClearRelationship(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))

SetHandlerClearRelationship sets the handler for the ClearRelationship method

func (*Protocol) SetHandlerDeclineFriendship ¶

func (protocol *Protocol) SetHandlerDeclineFriendship(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))

SetHandlerDeclineFriendship sets the handler for the DeclineFriendship method

func (*Protocol) SetHandlerGetDetailedList ¶

func (protocol *Protocol) SetHandlerGetDetailedList(handler func(err error, packet nex.PacketInterface, callID uint32, byRelationship *types.PrimitiveU8, bReversed *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerGetDetailedList sets the handler for the GetDetailedList method

func (*Protocol) SetHandlerGetList ¶

func (protocol *Protocol) SetHandlerGetList(handler func(err error, packet nex.PacketInterface, callID uint32, byRelationship *types.PrimitiveU8, bReversed *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerGetList sets the handler for the GetList method

func (*Protocol) SetHandlerGetRelationships ¶

func (protocol *Protocol) SetHandlerGetRelationships(handler func(err error, packet nex.PacketInterface, callID uint32, resultRange *types.ResultRange) (*nex.RMCMessage, *nex.Error))

SetHandlerGetRelationships sets the handler for the GetRelationships method

func (*Protocol) SetHandlerUpdateDetails ¶

func (protocol *Protocol) SetHandlerUpdateDetails(handler func(err error, packet nex.PacketInterface, callID uint32, uiPlayer *types.PrimitiveU32, uiDetails *types.PrimitiveU32) (*nex.RMCMessage, *nex.Error))

SetHandlerUpdateDetails sets the handler for the UpdateDetails method

Source Files ¶

View all Source files

Directories ¶

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

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