A LoadBalancingPeer provides the operations and enum definitions needed to use the LoadBalancing server application which is also used in Photon Cloud. More...

Inherits PhotonPeer.

Public Member Functions
	LoadBalancingPeer (ConnectionProtocol protocolType)
	Creates a Peer with specified connection protocol. You need to set the Listener before using the peer. More...

	LoadBalancingPeer (IPhotonPeerListener listener, ConnectionProtocol protocolType)
	Creates a Peer with specified connection protocol and a Listener for callbacks. More...

virtual bool	OpGetRegions (string appId)

virtual bool	OpJoinLobby (TypedLobby lobby=null)
	Joins the lobby on the Master Server, where you get a list of RoomInfos of currently open rooms. This is an async request which triggers a OnOperationResponse() call. More...

virtual bool	OpLeaveLobby ()
	Leaves the lobby on the Master Server. This is an async request which triggers a OnOperationResponse() call. More...

virtual bool	OpCreateRoom (EnterRoomParams opParams)
	Creates a room (on either Master or Game Server). The OperationResponse depends on the server the peer is connected to: Master will return a Game Server to connect to. Game Server will return the joined Room's data. This is an async request which triggers a OnOperationResponse() call. More...

virtual bool	OpJoinRoom (EnterRoomParams opParams)
	Joins a room by name or creates new room if room with given name not exists. The OperationResponse depends on the server the peer is connected to: Master will return a Game Server to connect to. Game Server will return the joined Room's data. This is an async request which triggers a OnOperationResponse() call. More...

virtual bool	OpJoinRandomRoom (OpJoinRandomRoomParams opJoinRandomRoomParams)
	Operation to join a random, available room. Overloads take additional player properties. This is an async request which triggers a OnOperationResponse() call. If all rooms are closed or full, the OperationResponse will have a returnCode of ErrorCode.NoRandomMatchFound. If successful, the OperationResponse contains a gameserver address and the name of some room. More...

virtual bool	OpJoinRandomOrCreateRoom (OpJoinRandomRoomParams opJoinRandomRoomParams, EnterRoomParams createRoomParams)
	Only used on the Master Server. It will assign a game server and room to join-or-create. On the Game Server, the OpJoin is used with option "create if not exists". More...

virtual bool	OpLeaveRoom (bool becomeInactive, bool sendAuthCookie=false)
	Leaves a room with option to come back later or "for good". More...

virtual bool	OpGetGameList (TypedLobby lobby, string queryData)
	Gets a list of games matching a SQL-like where clause. More...

virtual bool	OpFindFriends (string[] friendsToFind, FindFriendsOptions options=null)
	Request the rooms and online status for a list of friends (each client must set a unique username via OpAuthenticate). More...

bool	OpSetCustomPropertiesOfActor (int actorNr, Hashtable actorProperties)

bool	OpSetCustomPropertiesOfRoom (Hashtable gameProperties)

virtual bool	OpAuthenticate (string appId, string appVersion, AuthenticationValues authValues, string regionCode, bool getLobbyStatistics)
	Sends this app's appId and appVersion to identify this application server side. This is an async request which triggers a OnOperationResponse() call. More...

virtual bool	OpAuthenticateOnce (string appId, string appVersion, AuthenticationValues authValues, string regionCode, EncryptionMode encryptionMode, ConnectionProtocol expectedProtocol)
	Sends this app's appId and appVersion to identify this application server side. This is an async request which triggers a OnOperationResponse() call. More...

virtual bool	OpChangeGroups (byte[] groupsToRemove, byte[] groupsToAdd)
	Operation to handle this client's interest groups (for events in room). More...

virtual bool	OpRaiseEvent (byte eventCode, object customEventContent, RaiseEventOptions raiseEventOptions, SendOptions sendOptions)
	Send an event with custom code/type and any content to the other players in the same room. More...

virtual bool	OpSettings (bool receiveLobbyStats)
	Internally used operation to set some "per server" settings. This is for the Master Server. More...

Protected Member Functions
bool	OpSetPropertyOfRoom (byte propCode, object value)

Detailed Description

A LoadBalancingPeer provides the operations and enum definitions needed to use the LoadBalancing server application which is also used in Photon Cloud.

This class is internally used. The LoadBalancingPeer does not keep a state, instead this is done by a LoadBalancingClient.

Constructor & Destructor Documentation

◆ LoadBalancingPeer() [1/2]

LoadBalancingPeer ( ConnectionProtocol protocolType )

Creates a Peer with specified connection protocol. You need to set the Listener before using the peer.

Each connection protocol has it's own default networking ports for Photon.

Parameters

protocolType The preferred option is UDP.

◆ LoadBalancingPeer() [2/2]

LoadBalancingPeer	(	IPhotonPeerListener	listener,
		ConnectionProtocol	protocolType
	)

Creates a Peer with specified connection protocol and a Listener for callbacks.

Member Function Documentation

◆ OpAuthenticate()

virtual bool OpAuthenticate	(	string	appId,
		string	appVersion,
		AuthenticationValues	authValues,
		string	regionCode,
		bool	getLobbyStatistics
	)

virtual

Sends this app's appId and appVersion to identify this application server side. This is an async request which triggers a OnOperationResponse() call.

This operation makes use of encryption, if that is established before. See: EstablishEncryption(). Check encryption with IsEncryptionAvailable. This operation is allowed only once per connection (multiple calls will have ErrorCode != Ok).

Parameters

appId	Your application's name or ID to authenticate. This is assigned by Photon Cloud (webpage).
appVersion	The client's version (clients with differing client appVersions are separated and players don't meet).
authValues	Contains all values relevant for authentication. Even without account system (external Custom Auth), the clients are allowed to identify themselves.
regionCode	Optional region code, if the client should connect to a specific Photon Cloud Region.
getLobbyStatistics	Set to true on Master Server to receive "Lobby Statistics" events.

Returns: If the operation could be sent (has to be connected).

◆ OpAuthenticateOnce()

virtual bool OpAuthenticateOnce	(	string	appId,
		string	appVersion,
		AuthenticationValues	authValues,
		string	regionCode,
		EncryptionMode	encryptionMode,
		ConnectionProtocol	expectedProtocol
	)

virtual

Sends this app's appId and appVersion to identify this application server side. This is an async request which triggers a OnOperationResponse() call.

This operation makes use of encryption, if that is established before. See: EstablishEncryption(). Check encryption with IsEncryptionAvailable. This operation is allowed only once per connection (multiple calls will have ErrorCode != Ok).

Parameters

appId	Your application's name or ID to authenticate. This is assigned by Photon Cloud (webpage).
appVersion	The client's version (clients with differing client appVersions are separated and players don't meet).
authValues	Optional authentication values. The client can set no values or a UserId or some parameters for Custom Authentication by a server.
regionCode	Optional region code, if the client should connect to a specific Photon Cloud Region.
encryptionMode
expectedProtocol

Returns: If the operation could be sent (has to be connected).

◆ OpChangeGroups()

virtual bool OpChangeGroups	(	byte[]	groupsToRemove,
		byte[]	groupsToAdd
	)

virtual

Operation to handle this client's interest groups (for events in room).

Note the difference between passing null and byte[0]: null won't add/remove any groups. byte[0] will add/remove all (existing) groups. First, removing groups is executed. This way, you could leave all groups and join only the ones provided.

Changes become active not immediately but when the server executes this operation (approximately RTT/2).

Parameters

groupsToRemove	Groups to remove from interest. Null will not remove any. A byte[0] will remove all.
groupsToAdd	Groups to add to interest. Null will not add any. A byte[0] will add all current.

Returns: If operation could be enqueued for sending. Sent when calling: Service or SendOutgoingCommands.

◆ OpCreateRoom()

virtual bool OpCreateRoom ( EnterRoomParams opParams )

virtual

Creates a room (on either Master or Game Server). The OperationResponse depends on the server the peer is connected to: Master will return a Game Server to connect to. Game Server will return the joined Room's data. This is an async request which triggers a OnOperationResponse() call.

If the room is already existing, the OperationResponse will have a returnCode of ErrorCode.GameAlreadyExists.

◆ OpFindFriends()

virtual bool OpFindFriends	(	string[]	friendsToFind,
		FindFriendsOptions	options = `null`
	)

virtual

Request the rooms and online status for a list of friends (each client must set a unique username via OpAuthenticate).

Used on Master Server to find the rooms played by a selected list of users. Users identify themselves by using OpAuthenticate with a unique user ID. The list of user IDs must be fetched from some other source (not provided by Photon).

The server response includes 2 arrays of info (each index matching a friend from the request):
ParameterCode.FindFriendsResponseOnlineList = bool[] of online states
ParameterCode.FindFriendsResponseRoomIdList = string[] of room names (empty string if not in a room)

The options may be used to define which state a room must match to be returned.

Parameters

friendsToFind	Array of friend's names (make sure they are unique).
options	Options that affect the result of the FindFriends operation.

Returns: If the operation could be sent (requires connection).

◆ OpGetGameList()

virtual bool OpGetGameList	(	TypedLobby	lobby,
		string	queryData
	)

virtual

Gets a list of games matching a SQL-like where clause.

Operation is only available in lobbies of type SqlLobby. This is an async request which triggers a OnOperationResponse() call. Returned game list is stored in RoomInfoList.

Parameters

lobby	The lobby to query. Has to be of type SqlLobby.
queryData	The sql query statement.

Returns: If the operation could be sent (has to be connected).

◆ OpJoinLobby()

virtual bool OpJoinLobby ( TypedLobby lobby = null )

virtual

Joins the lobby on the Master Server, where you get a list of RoomInfos of currently open rooms. This is an async request which triggers a OnOperationResponse() call.

Parameters

lobby The lobby join to.

Returns: If the operation could be sent (has to be connected).

◆ OpJoinRandomOrCreateRoom()

virtual bool OpJoinRandomOrCreateRoom	(	OpJoinRandomRoomParams	opJoinRandomRoomParams,
		EnterRoomParams	createRoomParams
	)

virtual

Only used on the Master Server. It will assign a game server and room to join-or-create. On the Game Server, the OpJoin is used with option "create if not exists".

◆ OpJoinRandomRoom()

virtual bool OpJoinRandomRoom ( OpJoinRandomRoomParams opJoinRandomRoomParams )

virtual

Operation to join a random, available room. Overloads take additional player properties. This is an async request which triggers a OnOperationResponse() call. If all rooms are closed or full, the OperationResponse will have a returnCode of ErrorCode.NoRandomMatchFound. If successful, the OperationResponse contains a gameserver address and the name of some room.

Returns: If the operation could be sent currently (requires connection).

◆ OpJoinRoom()

virtual bool OpJoinRoom ( EnterRoomParams opParams )

virtual

Joins a room by name or creates new room if room with given name not exists. The OperationResponse depends on the server the peer is connected to: Master will return a Game Server to connect to. Game Server will return the joined Room's data. This is an async request which triggers a OnOperationResponse() call.

If the room is not existing (anymore), the OperationResponse will have a returnCode of ErrorCode.GameDoesNotExist. Other possible ErrorCodes are: GameClosed, GameFull.

Returns: If the operation could be sent (requires connection).

◆ OpLeaveLobby()

virtual bool OpLeaveLobby ( )

virtual

Leaves the lobby on the Master Server. This is an async request which triggers a OnOperationResponse() call.

Returns: If the operation could be sent (requires connection).

◆ OpLeaveRoom()

virtual bool OpLeaveRoom	(	bool	becomeInactive,
		bool	sendAuthCookie = `false`
	)

virtual

Leaves a room with option to come back later or "for good".

Parameters

becomeInactive	Async games can be re-joined (loaded) later on. Set to false, if you want to abandon a game entirely.
sendAuthCookie	WebFlag: Securely transmit the encrypted object AuthCookie to the web service in PathLeave webhook when available

Returns: If the opteration can be send currently.

◆ OpRaiseEvent()

virtual bool OpRaiseEvent	(	byte	eventCode,
		object	customEventContent,
		RaiseEventOptions	raiseEventOptions,
		SendOptions	sendOptions
	)

virtual

Send an event with custom code/type and any content to the other players in the same room.

This override explicitly uses another parameter order to not mix it up with the implementation for Hashtable only.

Parameters

eventCode	Identifies this type of event (and the content). Your game's event codes can start with 0.
customEventContent	Any serializable datatype (including Hashtable like the other OpRaiseEvent overloads).
raiseEventOptions	Contains (slightly) less often used options. If you pass null, the default options will be used.
sendOptions	Send options for reliable, encryption etc

Returns: If operation could be enqueued for sending. Sent when calling: Service or SendOutgoingCommands.

◆ OpSettings()

virtual bool OpSettings ( bool receiveLobbyStats )

virtual

Internally used operation to set some "per server" settings. This is for the Master Server.

Parameters

receiveLobbyStats Set to true, to get Lobby Statistics (lists of existing lobbies).

Returns: False if the operation could not be sent.

Photon Unity Networking 2 2.45

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LoadBalancingPeer() [1/2]

◆ LoadBalancingPeer() [2/2]

Member Function Documentation

◆ OpAuthenticate()

◆ OpAuthenticateOnce()

◆ OpChangeGroups()

◆ OpCreateRoom()

◆ OpFindFriends()

◆ OpGetGameList()

◆ OpJoinLobby()

◆ OpJoinRandomOrCreateRoom()

◆ OpJoinRandomRoom()

◆ OpJoinRoom()

◆ OpLeaveLobby()

◆ OpLeaveRoom()

◆ OpRaiseEvent()

◆ OpSettings()