protocol

package
v2.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 19, 2024 License: AGPL-3.0 Imports: 6 Imported by: 1

Documentation

Overview

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Package protocol implements the DataStore protocol

Index

Constants

View Source 
const (
	// ProtocolID is the protocol ID for the DataStore protocol
	ProtocolID = 0x73

	// MethodPrepareGetObjectV1 is the method ID for the method PrepareGetObjectV1
	MethodPrepareGetObjectV1 = 0x1

	// MethodPreparePostObjectV1 is the method ID for the method PreparePostObjectV1
	MethodPreparePostObjectV1 = 0x2

	// MethodCompletePostObjectV1 is the method ID for the method CompletePostObjectV1
	MethodCompletePostObjectV1 = 0x3

	// MethodDeleteObject is the method ID for the method DeleteObject
	MethodDeleteObject = 0x4

	// MethodDeleteObjects is the method ID for the method DeleteObjects
	MethodDeleteObjects = 0x5

	// MethodChangeMetaV1 is the method ID for the method ChangeMetaV1
	MethodChangeMetaV1 = 0x6

	// MethodChangeMetasV1 is the method ID for the method ChangeMetasV1
	MethodChangeMetasV1 = 0x7

	// MethodGetMeta is the method ID for the method GetMeta
	MethodGetMeta = 0x8

	// MethodGetMetas is the method ID for the method GetMetas
	MethodGetMetas = 0x9

	// MethodPrepareUpdateObject is the method ID for the method PrepareUpdateObject
	MethodPrepareUpdateObject = 0xA

	// MethodCompleteUpdateObject is the method ID for the method CompleteUpdateObject
	MethodCompleteUpdateObject = 0xB

	// MethodSearchObject is the method ID for the method SearchObject
	MethodSearchObject = 0xC

	// MethodGetNotificationURL is the method ID for the method GetNotificationURL
	MethodGetNotificationURL = 0xD

	// MethodGetNewArrivedNotificationsV1 is the method ID for the method GetNewArrivedNotificationsV1
	MethodGetNewArrivedNotificationsV1 = 0xE

	// MethodRateObject is the method ID for the method RateObject
	MethodRateObject = 0xF

	// MethodGetRating is the method ID for the method GetRating
	MethodGetRating = 0x10

	// MethodGetRatings is the method ID for the method GetRatings
	MethodGetRatings = 0x11

	// MethodResetRating is the method ID for the method ResetRating
	MethodResetRating = 0x12

	// MethodResetRatings is the method ID for the method ResetRatings
	MethodResetRatings = 0x13

	// MethodGetSpecificMetaV1 is the method ID for the method GetSpecificMetaV1
	MethodGetSpecificMetaV1 = 0x14

	// MethodPostMetaBinary is the method ID for the method PostMetaBinary
	MethodPostMetaBinary = 0x15

	// MethodTouchObject is the method ID for the method TouchObject
	MethodTouchObject = 0x16

	// MethodGetRatingWithLog is the method ID for the method GetRatingWithLog
	MethodGetRatingWithLog = 0x17

	// MethodPreparePostObject is the method ID for the method PreparePostObject
	MethodPreparePostObject = 0x18

	// MethodPrepareGetObject is the method ID for the method PrepareGetObject
	MethodPrepareGetObject = 0x19

	// MethodCompletePostObject is the method ID for the method CompletePostObject
	MethodCompletePostObject = 0x1A

	// MethodGetNewArrivedNotifications is the method ID for the method GetNewArrivedNotifications
	MethodGetNewArrivedNotifications = 0x1B

	// MethodGetSpecificMeta is the method ID for the method GetSpecificMeta
	MethodGetSpecificMeta = 0x1C

	// MethodGetPersistenceInfo is the method ID for the method GetPersistenceInfo
	MethodGetPersistenceInfo = 0x1D

	// MethodGetPersistenceInfos is the method ID for the method GetPersistenceInfos
	MethodGetPersistenceInfos = 0x1E

	// MethodPerpetuateObject is the method ID for the method PerpetuateObject
	MethodPerpetuateObject = 0x1F

	// MethodUnperpetuateObject is the method ID for the method UnperpetuateObject
	MethodUnperpetuateObject = 0x20

	// MethodPrepareGetObjectOrMetaBinary is the method ID for the method PrepareGetObjectOrMetaBinary
	MethodPrepareGetObjectOrMetaBinary = 0x21

	// MethodGetPasswordInfo is the method ID for the method GetPasswordInfo
	MethodGetPasswordInfo = 0x22

	// MethodGetPasswordInfos is the method ID for the method GetPasswordInfos
	MethodGetPasswordInfos = 0x23

	// MethodGetMetasMultipleParam is the method ID for the method GetMetasMultipleParam
	MethodGetMetasMultipleParam = 0x24

	// MethodCompletePostObjects is the method ID for the method CompletePostObjects
	MethodCompletePostObjects = 0x25

	// MethodChangeMeta is the method ID for the method ChangeMeta
	MethodChangeMeta = 0x26

	// MethodChangeMetas is the method ID for the method ChangeMetas
	MethodChangeMetas = 0x27

	// MethodRateObjects is the method ID for the method RateObjects
	MethodRateObjects = 0x28

	// MethodPostMetaBinaryWithDataID is the method ID for the method PostMetaBinaryWithDataID
	MethodPostMetaBinaryWithDataID = 0x29

	// MethodPostMetaBinariesWithDataID is the method ID for the method PostMetaBinariesWithDataID
	MethodPostMetaBinariesWithDataID = 0x2A

	// MethodRateObjectWithPosting is the method ID for the method RateObjectWithPosting
	MethodRateObjectWithPosting = 0x2B

	// MethodRateObjectsWithPosting is the method ID for the method RateObjectsWithPosting
	MethodRateObjectsWithPosting = 0x2C

	// MethodGetObjectInfos is the method ID for the method GetObjectInfos
	MethodGetObjectInfos = 0x2D

	// MethodSearchObjectLight is the method ID for the method SearchObjectLight
	MethodSearchObjectLight = 0x2E
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Interface 

type Interface interface {
	Endpoint() nex.EndpointInterface
	SetEndpoint(endpoint nex.EndpointInterface)
	SetHandlerPrepareGetObjectV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParamV1) (*nex.RMCMessage, *nex.Error))
	SetHandlerPreparePostObjectV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParamV1) (*nex.RMCMessage, *nex.Error))
	SetHandlerCompletePostObjectV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompletePostParamV1) (*nex.RMCMessage, *nex.Error))
	SetHandlerDeleteObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreDeleteParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerDeleteObjects(handler func(err error, packet nex.PacketInterface, callID uint32, params *types.List[*datastore_types.DataStoreDeleteParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerChangeMetaV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreChangeMetaParamV1) (*nex.RMCMessage, *nex.Error))
	SetHandlerChangeMetasV1(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStoreChangeMetaParamV1], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetMeta(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetMetaParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetMetas(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], param *datastore_types.DataStoreGetMetaParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerPrepareUpdateObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareUpdateParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerCompleteUpdateObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompleteUpdateParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetNotificationURL(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNotificationURLParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetNewArrivedNotificationsV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNewArrivedNotificationsParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerRateObject(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, param *datastore_types.DataStoreRateObjectParam, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetRating(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetRatings(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))
	SetHandlerResetRating(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))
	SetHandlerResetRatings(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetSpecificMetaV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetSpecificMetaParamV1) (*nex.RMCMessage, *nex.Error))
	SetHandlerPostMetaBinary(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerTouchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreTouchObjectParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetRatingWithLog(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))
	SetHandlerPreparePostObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerPrepareGetObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerCompletePostObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompletePostParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetNewArrivedNotifications(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNewArrivedNotificationsParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetSpecificMeta(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetSpecificMetaParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetPersistenceInfo(handler func(err error, packet nex.PacketInterface, callID uint32, ownerID *types.PID, persistenceSlotID *types.PrimitiveU16) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetPersistenceInfos(handler func(err error, packet nex.PacketInterface, callID uint32, ownerID *types.PID, persistenceSlotIDs *types.List[*types.PrimitiveU16]) (*nex.RMCMessage, *nex.Error))
	SetHandlerPerpetuateObject(handler func(err error, packet nex.PacketInterface, callID uint32, persistenceSlotID *types.PrimitiveU16, dataID *types.PrimitiveU64, deleteLastObject *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerUnperpetuateObject(handler func(err error, packet nex.PacketInterface, callID uint32, persistenceSlotID *types.PrimitiveU16, deleteLastObject *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerPrepareGetObjectOrMetaBinary(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetPasswordInfo(handler func(err error, packet nex.PacketInterface, callID uint32, dataID *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetPasswordInfos(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64]) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetMetasMultipleParam(handler func(err error, packet nex.PacketInterface, callID uint32, params *types.List[*datastore_types.DataStoreGetMetaParam]) (*nex.RMCMessage, *nex.Error))
	SetHandlerCompletePostObjects(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64]) (*nex.RMCMessage, *nex.Error))
	SetHandlerChangeMeta(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreChangeMetaParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerChangeMetas(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStoreChangeMetaParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerRateObjects(handler func(err error, packet nex.PacketInterface, callID uint32, targets *types.List[*datastore_types.DataStoreRatingTarget], params *types.List[*datastore_types.DataStoreRateObjectParam], transactional *types.PrimitiveBool, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerPostMetaBinaryWithDataID(handler func(err error, packet nex.PacketInterface, callID uint32, dataID *types.PrimitiveU64, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error))
	SetHandlerPostMetaBinariesWithDataID(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStorePreparePostParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerRateObjectWithPosting(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, rateParam *datastore_types.DataStoreRateObjectParam, postParam *datastore_types.DataStorePreparePostParam, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerRateObjectsWithPosting(handler func(err error, packet nex.PacketInterface, callID uint32, targets *types.List[*datastore_types.DataStoreRatingTarget], rateParams *types.List[*datastore_types.DataStoreRateObjectParam], postParams *types.List[*datastore_types.DataStorePreparePostParam], transactional *types.PrimitiveBool, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))
	SetHandlerGetObjectInfos(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))
	SetHandlerSearchObjectLight(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam) (*nex.RMCMessage, *nex.Error))
}

Interface implements the methods present on the DataStore Protocol struct

type Protocol 

type Protocol struct {
	PrepareGetObjectV1           func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParamV1) (*nex.RMCMessage, *nex.Error)
	PreparePostObjectV1          func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParamV1) (*nex.RMCMessage, *nex.Error)
	CompletePostObjectV1         func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompletePostParamV1) (*nex.RMCMessage, *nex.Error)
	DeleteObject                 func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreDeleteParam) (*nex.RMCMessage, *nex.Error)
	DeleteObjects                func(err error, packet nex.PacketInterface, callID uint32, params *types.List[*datastore_types.DataStoreDeleteParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	ChangeMetaV1                 func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreChangeMetaParamV1) (*nex.RMCMessage, *nex.Error)
	ChangeMetasV1                func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStoreChangeMetaParamV1], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	GetMeta                      func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetMetaParam) (*nex.RMCMessage, *nex.Error)
	GetMetas                     func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], param *datastore_types.DataStoreGetMetaParam) (*nex.RMCMessage, *nex.Error)
	PrepareUpdateObject          func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareUpdateParam) (*nex.RMCMessage, *nex.Error)
	CompleteUpdateObject         func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompleteUpdateParam) (*nex.RMCMessage, *nex.Error)
	SearchObject                 func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam) (*nex.RMCMessage, *nex.Error)
	GetNotificationURL           func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNotificationURLParam) (*nex.RMCMessage, *nex.Error)
	GetNewArrivedNotificationsV1 func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNewArrivedNotificationsParam) (*nex.RMCMessage, *nex.Error)
	RateObject                   func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, param *datastore_types.DataStoreRateObjectParam, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	GetRating                    func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error)
	GetRatings                   func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error)
	ResetRating                  func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error)
	ResetRatings                 func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	GetSpecificMetaV1            func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetSpecificMetaParamV1) (*nex.RMCMessage, *nex.Error)
	PostMetaBinary               func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error)
	TouchObject                  func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreTouchObjectParam) (*nex.RMCMessage, *nex.Error)
	GetRatingWithLog             func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error)
	PreparePostObject            func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error)
	PrepareGetObject             func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParam) (*nex.RMCMessage, *nex.Error)
	CompletePostObject           func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompletePostParam) (*nex.RMCMessage, *nex.Error)
	GetNewArrivedNotifications   func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNewArrivedNotificationsParam) (*nex.RMCMessage, *nex.Error)
	GetSpecificMeta              func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetSpecificMetaParam) (*nex.RMCMessage, *nex.Error)
	GetPersistenceInfo           func(err error, packet nex.PacketInterface, callID uint32, ownerID *types.PID, persistenceSlotID *types.PrimitiveU16) (*nex.RMCMessage, *nex.Error)
	GetPersistenceInfos          func(err error, packet nex.PacketInterface, callID uint32, ownerID *types.PID, persistenceSlotIDs *types.List[*types.PrimitiveU16]) (*nex.RMCMessage, *nex.Error)
	PerpetuateObject             func(err error, packet nex.PacketInterface, callID uint32, persistenceSlotID *types.PrimitiveU16, dataID *types.PrimitiveU64, deleteLastObject *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	UnperpetuateObject           func(err error, packet nex.PacketInterface, callID uint32, persistenceSlotID *types.PrimitiveU16, deleteLastObject *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	PrepareGetObjectOrMetaBinary func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParam) (*nex.RMCMessage, *nex.Error)
	GetPasswordInfo              func(err error, packet nex.PacketInterface, callID uint32, dataID *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error)
	GetPasswordInfos             func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64]) (*nex.RMCMessage, *nex.Error)
	GetMetasMultipleParam        func(err error, packet nex.PacketInterface, callID uint32, params *types.List[*datastore_types.DataStoreGetMetaParam]) (*nex.RMCMessage, *nex.Error)
	CompletePostObjects          func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64]) (*nex.RMCMessage, *nex.Error)
	ChangeMeta                   func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreChangeMetaParam) (*nex.RMCMessage, *nex.Error)
	ChangeMetas                  func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStoreChangeMetaParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	RateObjects                  func(err error, packet nex.PacketInterface, callID uint32, targets *types.List[*datastore_types.DataStoreRatingTarget], params *types.List[*datastore_types.DataStoreRateObjectParam], transactional *types.PrimitiveBool, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	PostMetaBinaryWithDataID     func(err error, packet nex.PacketInterface, callID uint32, dataID *types.PrimitiveU64, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error)
	PostMetaBinariesWithDataID   func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStorePreparePostParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	RateObjectWithPosting        func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, rateParam *datastore_types.DataStoreRateObjectParam, postParam *datastore_types.DataStorePreparePostParam, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	RateObjectsWithPosting       func(err error, packet nex.PacketInterface, callID uint32, targets *types.List[*datastore_types.DataStoreRatingTarget], rateParams *types.List[*datastore_types.DataStoreRateObjectParam], postParams *types.List[*datastore_types.DataStorePreparePostParam], transactional *types.PrimitiveBool, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error)
	GetObjectInfos               func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error)
	SearchObjectLight            func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam) (*nex.RMCMessage, *nex.Error)
	Patches                      nex.ServiceProtocol
	PatchedMethods               []uint32
	// contains filtered or unexported fields
}

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

func NewProtocol 

func NewProtocol() *Protocol

NewProtocol returns a new DataStore 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) SetHandlerChangeMeta 

func (protocol *Protocol) SetHandlerChangeMeta(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreChangeMetaParam) (*nex.RMCMessage, *nex.Error))

SetHandlerChangeMeta sets the handler for the ChangeMeta method

func (*Protocol) SetHandlerChangeMetaV1 

func (protocol *Protocol) SetHandlerChangeMetaV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreChangeMetaParamV1) (*nex.RMCMessage, *nex.Error))

SetHandlerChangeMetaV1 sets the handler for the ChangeMetaV1 method

func (*Protocol) SetHandlerChangeMetas 

func (protocol *Protocol) SetHandlerChangeMetas(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStoreChangeMetaParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerChangeMetas sets the handler for the ChangeMetas method

func (*Protocol) SetHandlerChangeMetasV1 

func (protocol *Protocol) SetHandlerChangeMetasV1(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStoreChangeMetaParamV1], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerChangeMetasV1 sets the handler for the ChangeMetasV1 method

func (*Protocol) SetHandlerCompletePostObject 

func (protocol *Protocol) SetHandlerCompletePostObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompletePostParam) (*nex.RMCMessage, *nex.Error))

SetHandlerCompletePostObject sets the handler for the CompletePostObject method

func (*Protocol) SetHandlerCompletePostObjectV1 

func (protocol *Protocol) SetHandlerCompletePostObjectV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompletePostParamV1) (*nex.RMCMessage, *nex.Error))

SetHandlerCompletePostObjectV1 sets the handler for the CompletePostObjectV1 method

func (*Protocol) SetHandlerCompletePostObjects 

func (protocol *Protocol) SetHandlerCompletePostObjects(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64]) (*nex.RMCMessage, *nex.Error))

SetHandlerCompletePostObjects sets the handler for the CompletePostObjects method

func (*Protocol) SetHandlerCompleteUpdateObject 

func (protocol *Protocol) SetHandlerCompleteUpdateObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreCompleteUpdateParam) (*nex.RMCMessage, *nex.Error))

SetHandlerCompleteUpdateObject sets the handler for the CompleteUpdateObject method

func (*Protocol) SetHandlerDeleteObject 

func (protocol *Protocol) SetHandlerDeleteObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreDeleteParam) (*nex.RMCMessage, *nex.Error))

SetHandlerDeleteObject sets the handler for the DeleteObject method

func (*Protocol) SetHandlerDeleteObjects 

func (protocol *Protocol) SetHandlerDeleteObjects(handler func(err error, packet nex.PacketInterface, callID uint32, params *types.List[*datastore_types.DataStoreDeleteParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerDeleteObjects sets the handler for the DeleteObjects method

func (*Protocol) SetHandlerGetMeta 

func (protocol *Protocol) SetHandlerGetMeta(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetMetaParam) (*nex.RMCMessage, *nex.Error))

SetHandlerGetMeta sets the handler for the GetMeta method

func (*Protocol) SetHandlerGetMetas 

func (protocol *Protocol) SetHandlerGetMetas(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], param *datastore_types.DataStoreGetMetaParam) (*nex.RMCMessage, *nex.Error))

SetHandlerGetMetas sets the handler for the GetMetas method

func (*Protocol) SetHandlerGetMetasMultipleParam 

func (protocol *Protocol) SetHandlerGetMetasMultipleParam(handler func(err error, packet nex.PacketInterface, callID uint32, params *types.List[*datastore_types.DataStoreGetMetaParam]) (*nex.RMCMessage, *nex.Error))

SetHandlerGetMetasMultipleParam sets the handler for the GetMetasMultipleParam method

func (*Protocol) SetHandlerGetNewArrivedNotifications 

func (protocol *Protocol) SetHandlerGetNewArrivedNotifications(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNewArrivedNotificationsParam) (*nex.RMCMessage, *nex.Error))

SetHandlerGetNewArrivedNotifications sets the handler for the GetNewArrivedNotifications method

func (*Protocol) SetHandlerGetNewArrivedNotificationsV1 

func (protocol *Protocol) SetHandlerGetNewArrivedNotificationsV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNewArrivedNotificationsParam) (*nex.RMCMessage, *nex.Error))

SetHandlerGetNewArrivedNotificationsV1 sets the handler for the GetNewArrivedNotificationsV1 method

func (*Protocol) SetHandlerGetNotificationURL 

func (protocol *Protocol) SetHandlerGetNotificationURL(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetNotificationURLParam) (*nex.RMCMessage, *nex.Error))

SetHandlerGetNotificationURL sets the handler for the GetNotificationURL method

func (*Protocol) SetHandlerGetObjectInfos 

func (protocol *Protocol) SetHandlerGetObjectInfos(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))

SetHandlerGetObjectInfos sets the handler for the GetObjectInfos method

func (*Protocol) SetHandlerGetPasswordInfo 

func (protocol *Protocol) SetHandlerGetPasswordInfo(handler func(err error, packet nex.PacketInterface, callID uint32, dataID *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))

SetHandlerGetPasswordInfo sets the handler for the GetPasswordInfo method

func (*Protocol) SetHandlerGetPasswordInfos 

func (protocol *Protocol) SetHandlerGetPasswordInfos(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64]) (*nex.RMCMessage, *nex.Error))

SetHandlerGetPasswordInfos sets the handler for the GetPasswordInfos method

func (*Protocol) SetHandlerGetPersistenceInfo 

func (protocol *Protocol) SetHandlerGetPersistenceInfo(handler func(err error, packet nex.PacketInterface, callID uint32, ownerID *types.PID, persistenceSlotID *types.PrimitiveU16) (*nex.RMCMessage, *nex.Error))

SetHandlerGetPersistenceInfo sets the handler for the GetPersistenceInfo method

func (*Protocol) SetHandlerGetPersistenceInfos 

func (protocol *Protocol) SetHandlerGetPersistenceInfos(handler func(err error, packet nex.PacketInterface, callID uint32, ownerID *types.PID, persistenceSlotIDs *types.List[*types.PrimitiveU16]) (*nex.RMCMessage, *nex.Error))

SetHandlerGetPersistenceInfos sets the handler for the GetPersistenceInfos method

func (*Protocol) SetHandlerGetRating 

func (protocol *Protocol) SetHandlerGetRating(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))

SetHandlerGetRating sets the handler for the GetRating method

func (*Protocol) SetHandlerGetRatingWithLog 

func (protocol *Protocol) SetHandlerGetRatingWithLog(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))

SetHandlerGetRatingWithLog sets the handler for the GetRatingWithLog method

func (*Protocol) SetHandlerGetRatings 

func (protocol *Protocol) SetHandlerGetRatings(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))

SetHandlerGetRatings sets the handler for the GetRatings method

func (*Protocol) SetHandlerGetSpecificMeta 

func (protocol *Protocol) SetHandlerGetSpecificMeta(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetSpecificMetaParam) (*nex.RMCMessage, *nex.Error))

SetHandlerGetSpecificMeta sets the handler for the GetSpecificMeta method

func (*Protocol) SetHandlerGetSpecificMetaV1 

func (protocol *Protocol) SetHandlerGetSpecificMetaV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreGetSpecificMetaParamV1) (*nex.RMCMessage, *nex.Error))

SetHandlerGetSpecificMetaV1 sets the handler for the GetSpecificMetaV1 method

func (*Protocol) SetHandlerPerpetuateObject 

func (protocol *Protocol) SetHandlerPerpetuateObject(handler func(err error, packet nex.PacketInterface, callID uint32, persistenceSlotID *types.PrimitiveU16, dataID *types.PrimitiveU64, deleteLastObject *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerPerpetuateObject sets the handler for the PerpetuateObject method

func (*Protocol) SetHandlerPostMetaBinariesWithDataID 

func (protocol *Protocol) SetHandlerPostMetaBinariesWithDataID(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs *types.List[*types.PrimitiveU64], params *types.List[*datastore_types.DataStorePreparePostParam], transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerPostMetaBinariesWithDataID sets the handler for the PostMetaBinariesWithDataID method

func (*Protocol) SetHandlerPostMetaBinary 

func (protocol *Protocol) SetHandlerPostMetaBinary(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error))

SetHandlerPostMetaBinary sets the handler for the PostMetaBinary method

func (*Protocol) SetHandlerPostMetaBinaryWithDataID 

func (protocol *Protocol) SetHandlerPostMetaBinaryWithDataID(handler func(err error, packet nex.PacketInterface, callID uint32, dataID *types.PrimitiveU64, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error))

SetHandlerPostMetaBinaryWithDataID sets the handler for the PostMetaBinaryWithDataID method

func (*Protocol) SetHandlerPrepareGetObject 

func (protocol *Protocol) SetHandlerPrepareGetObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParam) (*nex.RMCMessage, *nex.Error))

SetHandlerPrepareGetObject sets the handler for the PrepareGetObject method

func (*Protocol) SetHandlerPrepareGetObjectOrMetaBinary 

func (protocol *Protocol) SetHandlerPrepareGetObjectOrMetaBinary(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParam) (*nex.RMCMessage, *nex.Error))

SetHandlerPrepareGetObjectOrMetaBinary sets the handler for the PrepareGetObjectOrMetaBinary method

func (*Protocol) SetHandlerPrepareGetObjectV1 

func (protocol *Protocol) SetHandlerPrepareGetObjectV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareGetParamV1) (*nex.RMCMessage, *nex.Error))

SetHandlerPrepareGetObjectV1 sets the handler for the PrepareGetObjectV1 method

func (*Protocol) SetHandlerPreparePostObject 

func (protocol *Protocol) SetHandlerPreparePostObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParam) (*nex.RMCMessage, *nex.Error))

SetHandlerPreparePostObject sets the handler for the PreparePostObject method

func (*Protocol) SetHandlerPreparePostObjectV1 

func (protocol *Protocol) SetHandlerPreparePostObjectV1(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePreparePostParamV1) (*nex.RMCMessage, *nex.Error))

SetHandlerPreparePostObjectV1 sets the handler for the PreparePostObjectV1 method

func (*Protocol) SetHandlerPrepareUpdateObject 

func (protocol *Protocol) SetHandlerPrepareUpdateObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStorePrepareUpdateParam) (*nex.RMCMessage, *nex.Error))

SetHandlerPrepareUpdateObject sets the handler for the PrepareUpdateObject method

func (*Protocol) SetHandlerRateObject 

func (protocol *Protocol) SetHandlerRateObject(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, param *datastore_types.DataStoreRateObjectParam, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerRateObject sets the handler for the RateObject method

func (*Protocol) SetHandlerRateObjectWithPosting 

func (protocol *Protocol) SetHandlerRateObjectWithPosting(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, rateParam *datastore_types.DataStoreRateObjectParam, postParam *datastore_types.DataStorePreparePostParam, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerRateObjectWithPosting sets the handler for the RateObjectWithPosting method

func (*Protocol) SetHandlerRateObjects 

func (protocol *Protocol) SetHandlerRateObjects(handler func(err error, packet nex.PacketInterface, callID uint32, targets *types.List[*datastore_types.DataStoreRatingTarget], params *types.List[*datastore_types.DataStoreRateObjectParam], transactional *types.PrimitiveBool, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerRateObjects sets the handler for the RateObjects method

func (*Protocol) SetHandlerRateObjectsWithPosting 

func (protocol *Protocol) SetHandlerRateObjectsWithPosting(handler func(err error, packet nex.PacketInterface, callID uint32, targets *types.List[*datastore_types.DataStoreRatingTarget], rateParams *types.List[*datastore_types.DataStoreRateObjectParam], postParams *types.List[*datastore_types.DataStorePreparePostParam], transactional *types.PrimitiveBool, fetchRatings *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerRateObjectsWithPosting sets the handler for the RateObjectsWithPosting method

func (*Protocol) SetHandlerResetRating 

func (protocol *Protocol) SetHandlerResetRating(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, accessPassword *types.PrimitiveU64) (*nex.RMCMessage, *nex.Error))

SetHandlerResetRating sets the handler for the ResetRating method

func (*Protocol) SetHandlerResetRatings 

func (protocol *Protocol) SetHandlerResetRatings(handler func(err error, packet nex.PacketInterface, callID uint32, target *datastore_types.DataStoreRatingTarget, transactional *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerResetRatings sets the handler for the ResetRatings method

func (*Protocol) SetHandlerSearchObject 

func (protocol *Protocol) SetHandlerSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam) (*nex.RMCMessage, *nex.Error))

SetHandlerSearchObject sets the handler for the SearchObject method

func (*Protocol) SetHandlerSearchObjectLight 

func (protocol *Protocol) SetHandlerSearchObjectLight(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam) (*nex.RMCMessage, *nex.Error))

SetHandlerSearchObjectLight sets the handler for the SearchObjectLight method

func (*Protocol) SetHandlerTouchObject 

func (protocol *Protocol) SetHandlerTouchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreTouchObjectParam) (*nex.RMCMessage, *nex.Error))

SetHandlerTouchObject sets the handler for the TouchObject method

func (*Protocol) SetHandlerUnperpetuateObject 

func (protocol *Protocol) SetHandlerUnperpetuateObject(handler func(err error, packet nex.PacketInterface, callID uint32, persistenceSlotID *types.PrimitiveU16, deleteLastObject *types.PrimitiveBool) (*nex.RMCMessage, *nex.Error))

SetHandlerUnperpetuateObject sets the handler for the UnperpetuateObject method

Source Files

View all Source files

Directories

Path Synopsis
Package protocol implements the Miitopia DataStore protocol
 Package protocol implements the Miitopia DataStore protocol
types
Package types implements all the types used by the DataStoreMiitopia protocol
 Package types implements all the types used by the DataStoreMiitopia protocol
Package protocol implements the Nintendo Badge Arcade DataStore protocol
 Package protocol implements the Nintendo Badge Arcade DataStore protocol
types
Package types implements all the types used by the DataStoreNintendoBadgeArcade protocol
 Package types implements all the types used by the DataStoreNintendoBadgeArcade protocol
Package protocol implements the DataStorePokemonBank protocol
 Package protocol implements the DataStorePokemonBank protocol
types
Package types implements all the types used by the DataStore protocol
 Package types implements all the types used by the DataStore protocol
Package protocol implements the DataStorePokemonGen6 protocol
 Package protocol implements the DataStorePokemonGen6 protocol
types
Package types implements all the types used by the DataStore protocol
 Package types implements all the types used by the DataStore protocol
Package protocol implements the DataStoreSuperMarioMaker protocol
 Package protocol implements the DataStoreSuperMarioMaker protocol
types
Package types implements all the types used by the DataStore protocol
 Package types implements all the types used by the DataStore protocol
Package protocol implements the Super Smash Bros.
 Package protocol implements the Super Smash Bros.
types
Package types implements all the types used by the DataStoreSuperSmashBros.4 protocol
 Package types implements all the types used by the DataStoreSuperSmashBros.4 protocol
Package types implements all the types used by the DataStore protocol
 Package types implements all the types used by the DataStore protocol

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.