Photon Server API
Public Member Functions | Properties | List of all members
Photon.SocketServer.Rpc.Operation Class Reference

This class is a common base class for operations that have properties flagged with the DataMemberAttribute. More...

Inheritance diagram for Photon.SocketServer.Rpc.Operation:
Photon.SocketServer.Rpc.DataContract Photon.Hive.Operations.ChangeGroups Photon.Hive.Operations.DebugGameRequest Photon.Hive.Operations.GetPropertiesRequest Photon.Hive.Operations.JoinGameRequest Photon.Hive.Operations.LeaveRequest Photon.Hive.Operations.RaiseEventRequest Photon.Hive.Operations.SetPropertiesRequest Photon.Hive.WebRpc.WebRpcRequest Photon.LoadBalancing.Operations.AuthenticateRequest Photon.LoadBalancing.Operations.FindFriendsRequest Photon.LoadBalancing.Operations.GetLobbyStatsRequest Photon.LoadBalancing.Operations.JoinLobbyRequest Photon.LoadBalancing.Operations.JoinRandomGameRequest Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer Photon.MmoDemo.Server.Operations.AddInterestArea Photon.MmoDemo.Server.Operations.AttachInterestArea Photon.MmoDemo.Server.Operations.CreateWorld Photon.MmoDemo.Server.Operations.DestroyItem Photon.MmoDemo.Server.Operations.DetachInterestArea Photon.MmoDemo.Server.Operations.EnterWorld Photon.MmoDemo.Server.Operations.GetProperties Photon.MmoDemo.Server.Operations.Move Photon.MmoDemo.Server.Operations.MoveInterestArea Photon.MmoDemo.Server.Operations.RadarSubscribe Photon.MmoDemo.Server.Operations.RaiseGenericEvent Photon.MmoDemo.Server.Operations.RemoveInterestArea Photon.MmoDemo.Server.Operations.SetProperties Photon.MmoDemo.Server.Operations.SetViewDistance Photon.MmoDemo.Server.Operations.SpawnItem Photon.MmoDemo.Server.Operations.SubscribeCounter Photon.MmoDemo.Server.Operations.SubscribeItem Photon.MmoDemo.Server.Operations.UnsubscribeItem

Public Member Functions

 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

OperationRequest OperationRequest [get]
 Gets the 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...
 

Additional Inherited Members

- 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

This class is a common base class for operations that have properties flagged with the DataMemberAttribute.

Constructor & Destructor Documentation

Photon.SocketServer.Rpc.Operation.Operation ( IRpcProtocol  protocol,
OperationRequest  request 
)
inline

Initializes a new instance of the Operation class. This contructor is used for incoming operations.

Parameters
protocolThere are some protcol specific types that need to be converted to other C# types, IRpcProtocol.TryConvertParameter is used for this purpose.
requestThe operation request containing the operations paramter values.
Photon.SocketServer.Rpc.Operation.Operation ( )
inline

Initializes a new instance of the Operation class. This contructor is used for outgoing operations.

Member Function Documentation

void Photon.SocketServer.Rpc.Operation.OnComplete ( )
inline

Updates photon counters for the measure execution time. Call OnStart first.

void Photon.SocketServer.Rpc.Operation.OnStart ( )
inline

Starts measuring the execution time. Call OnComplete to update photon counters.

Property Documentation

OperationRequest Photon.SocketServer.Rpc.Operation.OperationRequest
get

Gets the OperationRequest.