protocol

package
v1.0.58 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2023 License: AGPL-3.0 Imports: 7 Imported by: 2

Documentation

Overview

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Package protocol implements the DataStoreSuperMarioMaker protocol

Index

Constants

View Source 
const (
	// ProtocolID is the Protocol ID for the DataStore (Super Mario Maker) protocol
	ProtocolID = 0x73

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

	// MethodGetMetaByOwnerID is the method ID for the GetMetaByOwnerID method
	MethodGetMetaByOwnerID = 0x2E

	// MethodCustomSearchObject is the method ID for the CustomSearchObject method
	MethodCustomSearchObject = 0x2F

	// MethodRateCustomRanking is the method ID for the RateCustomRanking method
	MethodRateCustomRanking = 0x30

	// MethodGetCustomRanking is the method ID for the GetCustomRanking method
	MethodGetCustomRanking = 0x31

	// MethodGetCustomRankingByDataID is the method ID for the GetCustomRankingByDataID method
	MethodGetCustomRankingByDataID = 0x32

	// MethodDeleteCustomRanking is the method ID for the DeleteCustomRanking method
	MethodDeleteCustomRanking = 0x33

	// MethodAddToBufferQueue is the method ID for the AddToBufferQueue method
	MethodAddToBufferQueue = 0x34

	// MethodAddToBufferQueues is the method ID for the AddToBufferQueues method
	MethodAddToBufferQueues = 0x35

	// MethodGetBufferQueue is the method ID for the GetBufferQueue method
	MethodGetBufferQueue = 0x36

	// MethodGetBufferQueues is the method ID for the GetBufferQueues method
	MethodGetBufferQueues = 0x37

	// MethodClearBufferQueues is the method ID for the ClearBufferQueues method
	MethodClearBufferQueues = 0x38

	// MethodCompleteAttachFile is the method ID for the CompleteAttachFile method
	MethodCompleteAttachFile = 0x39

	// MethodCompleteAttachFileV1 is the method ID for the CompleteAttachFileV1 method
	MethodCompleteAttachFileV1 = 0x3A

	// MethodPrepareAttachFile is the method ID for the PrepareAttachFile method
	MethodPrepareAttachFile = 0x3B

	// MethodConditionalSearchObject is the method ID for the ConditionalSearchObject method
	MethodConditionalSearchObject = 0x3C

	// MethodGetApplicationConfig is the method ID for the GetApplicationConfig method
	MethodGetApplicationConfig = 0x3D

	// MethodSetApplicationConfig is the method ID for the SetApplicationConfig method
	MethodSetApplicationConfig = 0x3E

	// MethodDeleteApplicationConfig is the method ID for the DeleteApplicationConfig method
	MethodDeleteApplicationConfig = 0x3F

	// MethodLatestCourseSearchObject is the method ID for the LatestCourseSearchObject method
	MethodLatestCourseSearchObject = 0x40

	// MethodFollowingsLatestCourseSearchObject is the method ID for the FollowingsLatestCourseSearchObject method
	MethodFollowingsLatestCourseSearchObject = 0x41

	// MethodRecommendedCourseSearchObject is the method ID for the RecommendedCourseSearchObject method
	MethodRecommendedCourseSearchObject = 0x42

	// MethodScoreRangeCascadedSearchObject is the method ID for the ScoreRangeCascadedSearchObject method
	MethodScoreRangeCascadedSearchObject = 0x43

	// MethodSuggestedCourseSearchObject is the method ID for the SuggestedCourseSearchObject method
	MethodSuggestedCourseSearchObject = 0x44

	// MethodPreparePostObjectWithOwnerIDAndDataID is the method ID for the PreparePostObjectWithOwnerIDAndDataID method
	MethodPreparePostObjectWithOwnerIDAndDataID = 0x45

	// MethodCompletePostObjectWithOwnerID is the method ID for the CompletePostObjectWithOwnerID method
	MethodCompletePostObjectWithOwnerID = 0x46

	// MethodUploadCourseRecord is the method ID for the UploadCourseRecord method
	MethodUploadCourseRecord = 0x47

	// MethodGetCourseRecord is the method ID for the GetCourseRecord method
	MethodGetCourseRecord = 0x48

	// MethodDeleteCourseRecord is the method ID for the DeleteCourseRecord method
	MethodDeleteCourseRecord = 0x49

	// MethodGetApplicationConfigString is the method ID for the GetApplicationConfigString method
	MethodGetApplicationConfigString = 0x4A

	// MethodSetApplicationConfigString is the method ID for the SetApplicationConfigString method
	MethodSetApplicationConfigString = 0x4B

	// MethodGetDeletionReason is the method ID for the GetDeletionReason method
	MethodGetDeletionReason = 0x4C

	// MethodSetDeletionReason is the method ID for the SetDeletionReason method
	MethodSetDeletionReason = 0x4D

	// MethodGetMetasWithCourseRecord is the method ID for the GetMetasWithCourseRecord method
	MethodGetMetasWithCourseRecord = 0x4E

	// MethodCheckRateCustomRankingCounter is the method ID for the CheckRateCustomRankingCounter method
	MethodCheckRateCustomRankingCounter = 0x4F

	// MethodResetRateCustomRankingCounter is the method ID for the ResetRateCustomRankingCounter method
	MethodResetRateCustomRankingCounter = 0x50

	// MethodBestScoreRateCourseSearchObject is the method ID for the BestScoreRateCourseSearchObject method
	MethodBestScoreRateCourseSearchObject = 0x51

	// MethodCTRPickUpCourseSearchObject is the method ID for the CTRPickUpCourseSearchObject method
	MethodCTRPickUpCourseSearchObject = 0x52

	// MethodSetCachedRanking is the method ID for the SetCachedRanking method
	MethodSetCachedRanking = 0x53

	// MethodDeleteCachedRanking is the method ID for the DeleteCachedRanking method
	MethodDeleteCachedRanking = 0x54

	// MethodChangePlayablePlatform is the method ID for the ChangePlayablePlatform method
	MethodChangePlayablePlatform = 0x55

	// MethodSearchUnknownPlatformObjects is the method ID for the SearchUnknownPlatformObjects method
	MethodSearchUnknownPlatformObjects = 0x56

	// MethodReportCourse is the method ID for the ReportCourse method
	MethodReportCourse = 0x57
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Protocol added in v1.0.45 

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

Protocol stores all the RMC method handlers for the DataStore (Super Mario Maker) protocol and listens for requests Embeds the DataStore protocol

func NewProtocol added in v1.0.45 

func NewProtocol(server *nex.Server) *Protocol

NewProtocol returns a new DataStoreSuperMarioMaker protocol

func (*Protocol) AddToBufferQueue added in v1.0.47 

func (protocol *Protocol) AddToBufferQueue(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.BufferQueueParam, buffer []byte) uint32)

AddToBufferQueue sets the AddToBufferQueue handler function

func (*Protocol) AddToBufferQueues added in v1.0.45 

func (protocol *Protocol) AddToBufferQueues(handler func(err error, packet nex.PacketInterface, callID uint32, params []*datastore_super_mario_maker_types.BufferQueueParam, buffers [][]byte) uint32)

AddToBufferQueues sets the AddToBufferQueues handler function

func (*Protocol) BestScoreRateCourseSearchObject added in v1.0.47 

func (protocol *Protocol) BestScoreRateCourseSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

BestScoreRateCourseSearchObject sets the BestScoreRateCourseSearchObject handler function

func (*Protocol) CTRPickUpCourseSearchObject added in v1.0.45 

func (protocol *Protocol) CTRPickUpCourseSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

CTRPickUpCourseSearchObject sets the CTRPickUpCourseSearchObject handler function

func (*Protocol) ChangePlayablePlatform added in v1.0.47 

func (protocol *Protocol) ChangePlayablePlatform(handler func(err error, packet nex.PacketInterface, callID uint32, params []*datastore_super_mario_maker_types.DataStoreChangePlayablePlatformParam) uint32)

ChangePlayablePlatform sets the ChangePlayablePlatform handler function

func (*Protocol) CheckRateCustomRankingCounter added in v1.0.45 

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

CheckRateCustomRankingCounter sets the CheckRateCustomRankingCounter handler function

func (*Protocol) ClearBufferQueues added in v1.0.47 

func (protocol *Protocol) ClearBufferQueues(handler func(err error, packet nex.PacketInterface, callID uint32, params []*datastore_super_mario_maker_types.BufferQueueParam) uint32)

ClearBufferQueues sets the ClearBufferQueues handler function

func (*Protocol) CompleteAttachFile added in v1.0.45 

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

CompleteAttachFile sets the CompleteAttachFile handler function

func (*Protocol) CompleteAttachFileV1 added in v1.0.47 

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

CompleteAttachFileV1 sets the CompleteAttachFileV1 handler function

func (*Protocol) CompletePostObjectWithOwnerID added in v1.0.47 

func (protocol *Protocol) CompletePostObjectWithOwnerID(handler func(err error, packet nex.PacketInterface, callID uint32, ownerID uint32, param *datastore_types.DataStoreCompletePostParam) uint32)

CompletePostObjectWithOwnerID sets the CompletePostObjectWithOwnerID handler function

func (*Protocol) ConditionalSearchObject added in v1.0.47 

func (protocol *Protocol) ConditionalSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, condition uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

ConditionalSearchObject sets the ConditionalSearchObject handler function

func (*Protocol) CustomSearchObject added in v1.0.47 

func (protocol *Protocol) CustomSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, condition uint32, param *datastore_types.DataStoreSearchParam) uint32)

CustomSearchObject sets the CustomSearchObject handler function

func (*Protocol) DeleteApplicationConfig added in v1.0.47 

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

DeleteApplicationConfig sets the DeleteApplicationConfig handler function

func (*Protocol) DeleteCachedRanking added in v1.0.47 

func (protocol *Protocol) DeleteCachedRanking(handler func(err error, packet nex.PacketInterface, callID uint32, rankingType string, rankingArgs []string) uint32)

DeleteCachedRanking sets the DeleteCachedRanking handler function

func (*Protocol) DeleteCourseRecord added in v1.0.47 

func (protocol *Protocol) DeleteCourseRecord(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreGetCourseRecordParam) uint32)

DeleteCourseRecord sets the DeleteCourseRecord handler function

func (*Protocol) DeleteCustomRanking added in v1.0.47 

func (protocol *Protocol) DeleteCustomRanking(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDList []uint64) uint32)

DeleteCustomRanking sets the DeleteCustomRanking handler function

func (*Protocol) FollowingsLatestCourseSearchObject added in v1.0.45 

func (protocol *Protocol) FollowingsLatestCourseSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

FollowingsLatestCourseSearchObject sets the FollowingsLatestCourseSearchObject handler function

func (*Protocol) GetApplicationConfig added in v1.0.45 

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

GetApplicationConfig sets the GetApplicationConfig handler function

func (*Protocol) GetApplicationConfigString added in v1.0.45 

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

GetApplicationConfigString sets the GetApplicationConfigString handler function

func (*Protocol) GetBufferQueue added in v1.0.45 

func (protocol *Protocol) GetBufferQueue(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.BufferQueueParam) uint32)

GetBufferQueue sets the GetBufferQueue handler function

func (*Protocol) GetBufferQueues added in v1.0.47 

func (protocol *Protocol) GetBufferQueues(handler func(err error, packet nex.PacketInterface, callID uint32, params []*datastore_super_mario_maker_types.BufferQueueParam) uint32)

GetBufferQueues sets the GetBufferQueues handler function

func (*Protocol) GetCourseRecord added in v1.0.45 

func (protocol *Protocol) GetCourseRecord(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreGetCourseRecordParam) uint32)

GetCourseRecord sets the GetCourseRecord handler function

func (*Protocol) GetCustomRanking added in v1.0.47 

func (protocol *Protocol) GetCustomRanking(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreGetCustomRankingParam) uint32)

GetCustomRanking sets the GetCustomRanking handler function

func (*Protocol) GetCustomRankingByDataID added in v1.0.45 

func (protocol *Protocol) GetCustomRankingByDataID(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreGetCustomRankingByDataIDParam) uint32)

GetCustomRankingByDataID sets the GetCustomRankingByDataID handler function

func (*Protocol) GetDeletionReason added in v1.0.45 

func (protocol *Protocol) GetDeletionReason(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDLst []uint64) uint32)

GetDeletionReason sets the GetDeletionReason handler function

func (*Protocol) GetMetaByOwnerID added in v1.0.47 

func (protocol *Protocol) GetMetaByOwnerID(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreGetMetaByOwnerIDParam) uint32)

GetMetaByOwnerID sets the GetMetaByOwnerID handler function

func (*Protocol) GetMetasWithCourseRecord added in v1.0.45 

func (protocol *Protocol) GetMetasWithCourseRecord(handler func(err error, packet nex.PacketInterface, callID uint32, params []*datastore_super_mario_maker_types.DataStoreGetCourseRecordParam, metaParam *datastore_types.DataStoreGetMetaParam) uint32)

GetMetasWithCourseRecord sets the GetMetasWithCourseRecord handler function

func (*Protocol) GetObjectInfos added in v1.0.45 

func (protocol *Protocol) GetObjectInfos(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDs []uint64) uint32)

GetObjectInfos sets the GetObjectInfos handler function

func (*Protocol) HandlePacket added in v1.0.45 

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

HandlePacket sends the packet to the correct RMC method handler

func (*Protocol) LatestCourseSearchObject added in v1.0.47 

func (protocol *Protocol) LatestCourseSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

LatestCourseSearchObject sets the LatestCourseSearchObject handler function

func (*Protocol) PrepareAttachFile added in v1.0.45 

func (protocol *Protocol) PrepareAttachFile(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreAttachFileParam) uint32)

PrepareAttachFile sets the PrepareAttachFile handler function

func (*Protocol) PreparePostObjectWithOwnerIDAndDataID added in v1.0.47 

func (protocol *Protocol) PreparePostObjectWithOwnerIDAndDataID(handler func(err error, packet nex.PacketInterface, callID uint32, ownerID uint32, dataID uint64, param *datastore_types.DataStorePreparePostParam) uint32)

PreparePostObjectWithOwnerIDAndDataID sets the PreparePostObjectWithOwnerIDAndDataID handler function

func (*Protocol) RateCustomRanking added in v1.0.45 

func (protocol *Protocol) RateCustomRanking(handler func(err error, packet nex.PacketInterface, callID uint32, params []*datastore_super_mario_maker_types.DataStoreRateCustomRankingParam) uint32)

RateCustomRanking sets the RateCustomRanking handler function

func (*Protocol) RecommendedCourseSearchObject added in v1.0.45 

func (protocol *Protocol) RecommendedCourseSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

RecommendedCourseSearchObject sets the RecommendedCourseSearchObject handler function

func (*Protocol) ReportCourse added in v1.0.47 

func (protocol *Protocol) ReportCourse(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreReportCourseParam) uint32)

ReportCourse sets the ReportCourse handler function

func (*Protocol) ResetRateCustomRankingCounter added in v1.0.47 

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

ResetRateCustomRankingCounter sets the ResetRateCustomRankingCounter handler function

func (*Protocol) ScoreRangeCascadedSearchObject added in v1.0.47 

func (protocol *Protocol) ScoreRangeCascadedSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

ScoreRangeCascadedSearchObject sets the ScoreRangeCascadedSearchObject handler function

func (*Protocol) SearchUnknownPlatformObjects added in v1.0.47 

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

SearchUnknownPlatformObjects sets the SearchUnknownPlatformObjects handler function

func (*Protocol) SetApplicationConfig added in v1.0.47 

func (protocol *Protocol) SetApplicationConfig(handler func(err error, packet nex.PacketInterface, callID uint32, applicationID uint32, key uint32, value int32) uint32)

SetApplicationConfig sets the SetApplicationConfig handler function

func (*Protocol) SetApplicationConfigString added in v1.0.47 

func (protocol *Protocol) SetApplicationConfigString(handler func(err error, packet nex.PacketInterface, callID uint32, applicationID uint32, key uint32, value string) uint32)

SetApplicationConfigString sets the SetApplicationConfigString handler function

func (*Protocol) SetCachedRanking added in v1.0.47 

func (protocol *Protocol) SetCachedRanking(handler func(err error, packet nex.PacketInterface, callID uint32, rankingType string, rankingArgs []string, dataIDLst []uint64) uint32)

SetCachedRanking sets the SetCachedRanking handler function

func (*Protocol) SetDeletionReason added in v1.0.47 

func (protocol *Protocol) SetDeletionReason(handler func(err error, packet nex.PacketInterface, callID uint32, dataIDLst []uint64, deletionReason uint32) uint32)

SetDeletionReason sets the SetDeletionReason handler function

func (*Protocol) Setup added in v1.0.45 

func (protocol *Protocol) Setup()

Setup initializes the protocol

func (*Protocol) SuggestedCourseSearchObject added in v1.0.45 

func (protocol *Protocol) SuggestedCourseSearchObject(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_types.DataStoreSearchParam, extraData []string) uint32)

SuggestedCourseSearchObject sets the SuggestedCourseSearchObject handler function

func (*Protocol) UploadCourseRecord added in v1.0.45 

func (protocol *Protocol) UploadCourseRecord(handler func(err error, packet nex.PacketInterface, callID uint32, param *datastore_super_mario_maker_types.DataStoreUploadCourseRecordParam) uint32)

UploadCourseRecord sets the UploadCourseRecord handler function

Source Files

View all Source files

Directories

Path Synopsis
Package types implements all the types used by the DataStore (Super Mario Maker) protocol
 Package types implements all the types used by the DataStore (Super Mario Maker) 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.