Photon Server API Documentation v5.0RC1

Public Member Functions | Properties | List of all members
Photon.Hive.Operations.LeaveRequest Class Reference

Implements the Leave operation. More...

Inheritance diagram for Photon.Hive.Operations.LeaveRequest:
Photon.SocketServer.Rpc.Operation Photon.Hive.Plugin.ILeaveGameRequest Photon.SocketServer.Rpc.DataContract Photon.Hive.Plugin.IOperationRequest

Public Member Functions

 LeaveRequest (IRpcProtocol protocol, OperationRequest operationRequest)
 Initializes a new instance of the LeaveRequest class. More...
 
 LeaveRequest ()
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
 Operation (IRpcProtocol protocol, OperationRequest request)
 Initializes a new instance of the Operation class. This contructor is used for incoming operations. More...
 
 Operation ()
 Initializes a new instance of the Operation class. This contructor is used for outgoing operations. More...
 
void OnComplete ()
 Updates photon counters for the measure execution time. Call OnStart first. More...
 
void OnStart ()
 Starts measuring the execution time. Call OnComplete to update photon counters. More...
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.DataContract
string GetErrorMessage ()
 Gets a message containing descriptive entries for each missing or invalid paramter. More...
 
Dictionary< byte, object > ToDictionary ()
 Converts all properties flagged with the DataMemberAttribute to a dictionary. More...
 

Properties

bool IsCommingBack [get, set]
 
byte WebFlags [get, set]
 
byte OperationCode [get]
 
System.Collections.Generic.Dictionary< byte, object > Parameters [get]
 
- Properties inherited from Photon.SocketServer.Rpc.Operation
OperationRequest OperationRequest [get]
 Gets the underlying OperationRequest. More...
 
- Properties inherited from Photon.SocketServer.Rpc.DataContract
bool IsValid [get]
 Gets a value indicating whether all operation parameter are initialized. Call the GetErrorMessage method to get a detailed description for all missing parameters. More...
 
- Properties inherited from Photon.Hive.Plugin.ILeaveGameRequest
bool IsCommingBack [get, set]
 Indicates if the actor can rejoin the room later and should be marked as inactive. More...
 
- Properties inherited from Photon.Hive.Plugin.IOperationRequest
byte OperationCode [get]
 Unique reserved code per operation. More...
 
Dictionary< byte, object > Parameters [get]
 Operation request parameters combined as sent by client. More...
 
byte WebFlags [get, set]
 Request webflags optionnaly set by client to control webhooks behaviour. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
static long GetTimestamp ()
 
- Public Attributes inherited from Photon.SocketServer.Rpc.Operation
byte Code => this.OperationRequest.OperationCode
 
RequestMetaData RequestMetaData => this.OperationRequest?.RequestMetaData
 
- Protected Member Functions inherited from Photon.SocketServer.Rpc.Operation
virtual void OnCompleted ()
 this method is called from inside of OnComplete() if startTime is not null More...
 
virtual void OnStarted ()
 called from inside of OnStart just after startTime is set More...
 
- Protected Member Functions inherited from Photon.SocketServer.Rpc.DataContract
 DataContract (IRpcProtocol protocol, IDictionary< byte, object > dataMembers)
 Initializes a new instance of the DataContract class. The params dictionary is mapped to properties flagged with the DataMemberAttribute. Check the IsValid property after creation to determine if all paramters have been initialized correctly. More...
 
 DataContract ()
 Initializes a new instance of the DataContract class. More...
 
- Protected Attributes inherited from Photon.SocketServer.Rpc.DataContract
string errorMessage
 The error message. More...
 
bool isValid
 The is valid. More...
 

Detailed Description

Implements the Leave operation.

Constructor & Destructor Documentation

◆ LeaveRequest() [1/2]

Photon.Hive.Operations.LeaveRequest.LeaveRequest ( IRpcProtocol  protocol,
OperationRequest  operationRequest 
)
inline

Initializes a new instance of the LeaveRequest class.

Parameters
protocolThe protocol.
operationRequestOperation request containing the operation parameters.

◆ LeaveRequest() [2/2]

Photon.Hive.Operations.LeaveRequest.LeaveRequest ( )
inline

Property Documentation

◆ IsCommingBack

bool Photon.Hive.Operations.LeaveRequest.IsCommingBack
getset

◆ OperationCode

byte Photon.Hive.Operations.LeaveRequest.OperationCode
get

◆ Parameters

System.Collections.Generic.Dictionary<byte, object> Photon.Hive.Operations.LeaveRequest.Parameters
get

◆ WebFlags

byte Photon.Hive.Operations.LeaveRequest.WebFlags
getset