protocol

Documentation

Overview

Package protocol implements the Notifications protocol

Package protocol implements the Notifications protocol

Package protocol implements the Notifications protocol

Package protocol implements the Notfications protocol

Index

• Constants
• Variables
• func BuildNotificationType(category, subtype uint32) uint32
• type Protocol
  • func NewProtocol(server *nex.Server) *Protocol
  • func (protocol *Protocol) Setup()

Constants

const (
	// ProtocolID is the protocol ID for the Nintendo Notifications protocol
	ProtocolID = 0xE

	// MethodProcessNotificationEvent is the method ID for the method ProcessNotificationEvent
	MethodProcessNotificationEvent = 0x1
)

Variables

var NotificationCategories = notificationCategories{
	Participation:                3,
	OwnershipChanged:             4,
	RequestJoinGathering:         101,
	EndGathering:                 102,
	GatheringUnregistered:        109,
	HostChanged:                  110,
	ServiceItemRequestCompleted:  115,
	MatchmakeRefereeRoundStarted: 116,
	SystemPasswordChanged:        120,
	SystemPasswordCleared:        121,
	SwitchGathering:              122,
}

NotificationCategories is a list of all the categories a notification can be in the Notifications protocol

Not all of these are categories, some are stand-alone types This is a design choice made by NEX, not us

var NotificationSubTypes = notificationSubTypes{
	Participation: notificationParticipationSubTypes{
		None:           0,
		NewParticipant: 1,
		Cancelled:      2,
		Disconnected:   7,
		Ended:          8,
	},
	OwnershipChanged: notificationsOwnershipChangedSubTypes{
		None: 0,
	},
	RequestJoinGathering: notificationsRequestJoinGatheringSubTypes{
		None: 0,
	},
	EndGathering: notificationsEndGatheringSubTypes{
		None: 0,
	},
	GatheringUnregistered: notificationsGatheringUnregisteredSubTypes{
		None: 0,
	},
	HostChanged: notificationsHostChangedSubTypes{
		None: 0,
	},
	ServiceItemRequestCompleted: notificationsServiceItemRequestCompletedSubTypes{
		None: 0,
	},
	MatchmakeRefereeRoundStarted: notificationsMatchmakeRefereeRoundStartedSubTypes{
		None: 0,
	},
	SystemPasswordChanged: notificationsSystemPasswordChangedSubTypes{
		None: 0,
	},
	SystemPasswordCleared: notificationsSystemPasswordClearedSubTypes{
		None: 0,
	},
	SwitchGathering: notificationsSwitchGatheringSubTypes{
		None: 0,
	},
}

NotificationSubTypes is a list of all the subtypes a notification can be in a given category of the Notifications protocol

Not all categories have subtypes

Functions

func BuildNotificationType

func BuildNotificationType(category, subtype uint32) uint32

BuildNotificationType builds a combined type for NotificationEvents using a category and subtype

Types

type Protocol

type Protocol struct {
	Server *nex.Server
}

Protocol handles the Notifications protocol

func NewProtocol

func NewProtocol(server *nex.Server) *Protocol

NewProtocol returns a new Notifications protocol

func (*Protocol) Setup

func (protocol *Protocol) Setup()

Setup initializes the protocol