Photon Server API
Public Member Functions | Properties | List of all members
Photon.Hive.Operations.RaiseEventRequest Class Reference

Implements the RaiseEvent operation. More...

Inheritance diagram for Photon.Hive.Operations.RaiseEventRequest:
Photon.SocketServer.Rpc.Operation Photon.SocketServer.Rpc.DataContract

Public Member Functions

 RaiseEventRequest (IRpcProtocol protocol, OperationRequest operationRequest)
 Initializes a new instance of the RaiseEventRequest class. More...
 
 RaiseEventRequest ()
 Initializes a new instance of the RaiseEventRequest class. More...
 
string DumpRequest ()
 
- 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

int[] Actors [get, set]
 Gets or sets the actors which should receive the event. If set to null or an empty array the event will be sent to all actors in the room. More...
 
byte Cache [get, set]
 Gets or sets a value indicating how to use the EventCache. More...
 
object Data [get, set]
 Gets or sets the hashtable containing the data to send. More...
 
byte EvCode [get, set]
 Gets or sets a byte containing the Code to send. More...
 
bool Flush [get, set]
 Gets or sets a value indicating whether to flush the send queue. Flushing the send queue will override the configured photon send delay. More...
 
string GameId [get, set]
 Gets or sets the game id. More...
 
byte ReceiverGroup [get, set]
 Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event. More...
 
byte Group [get, set]
 Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event. More...
 
object internalWebFlags [get, set]
 
int CacheSliceIndex [get, set]
 
bool IsCacheOpRemoveFromCache [get]
 
bool IsCacheOpRemoveFromCacheForActorsLeft [get]
 
bool IsCacheSliceIndexOperation [get]
 
bool IsCacheOnlyOperation [get]
 
bool IsBroadcastOperation [get]
 
bool HttpForward [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 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

Implements the RaiseEvent operation.

Constructor & Destructor Documentation

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

Initializes a new instance of the RaiseEventRequest class.

Parameters
protocolThe protocol.
operationRequestOperation request containing the operation parameters.
Photon.Hive.Operations.RaiseEventRequest.RaiseEventRequest ( )
inline

Initializes a new instance of the RaiseEventRequest class.

Member Function Documentation

string Photon.Hive.Operations.RaiseEventRequest.DumpRequest ( )
inline

Property Documentation

int [] Photon.Hive.Operations.RaiseEventRequest.Actors
getset

Gets or sets the actors which should receive the event. If set to null or an empty array the event will be sent to all actors in the room.

Optional request parameter.

byte Photon.Hive.Operations.RaiseEventRequest.Cache
getset

Gets or sets a value indicating how to use the EventCache.

Optional request parameter. Ignored if the event is sent to individual actors (submitted Actors or Photon.Hive.Operations.ReceiverGroup.MasterClient).

int Photon.Hive.Operations.RaiseEventRequest.CacheSliceIndex
getset
object Photon.Hive.Operations.RaiseEventRequest.Data
getset

Gets or sets the hashtable containing the data to send.

Optional request parameter.

byte Photon.Hive.Operations.RaiseEventRequest.EvCode
getset

Gets or sets a byte containing the Code to send.

Optional request parameter.

bool Photon.Hive.Operations.RaiseEventRequest.Flush
getset

Gets or sets a value indicating whether to flush the send queue. Flushing the send queue will override the configured photon send delay.

Optional request parameter.

string Photon.Hive.Operations.RaiseEventRequest.GameId
getset

Gets or sets the game id.

Optional request parameter.

byte Photon.Hive.Operations.RaiseEventRequest.Group
getset

Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event.

Optional request parameter. Ignored if Actors are set.

bool Photon.Hive.Operations.RaiseEventRequest.HttpForward
getset
object Photon.Hive.Operations.RaiseEventRequest.internalWebFlags
getset
bool Photon.Hive.Operations.RaiseEventRequest.IsBroadcastOperation
get
bool Photon.Hive.Operations.RaiseEventRequest.IsCacheOnlyOperation
get
bool Photon.Hive.Operations.RaiseEventRequest.IsCacheOpRemoveFromCache
get
bool Photon.Hive.Operations.RaiseEventRequest.IsCacheOpRemoveFromCacheForActorsLeft
get
bool Photon.Hive.Operations.RaiseEventRequest.IsCacheSliceIndexOperation
get
byte Photon.Hive.Operations.RaiseEventRequest.OperationCode
get
System.Collections.Generic.Dictionary<byte, object> Photon.Hive.Operations.RaiseEventRequest.Parameters
get
byte Photon.Hive.Operations.RaiseEventRequest.ReceiverGroup
getset

Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event.

Optional request parameter. Ignored if Actors are set.

byte Photon.Hive.Operations.RaiseEventRequest.WebFlags
getset