Photon Server API Documentation v5.0RC1

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.Hive.Plugin.IRaiseEventRequest Photon.SocketServer.Rpc.DataContract Photon.Hive.Plugin.IOperationRequest

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 ()
 
void ValidateActorsList (int currentActorsCount)
 
- 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...
 
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]
 
bool SimulatesPhotonEvent [get]
 
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.IRaiseEventRequest
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...
 
string GameId [get, set]
 Gets or sets the game id. More...
 
byte Group [get, set]
 Target interest group if this event. More...
 
bool HttpForward [get, set]
 Gets or sets HttpForward webflag indicating whether GameEvent webhook should be sent. More...
 
byte ReceiverGroup [get, set]
 Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event. More...
 
int? CacheSliceIndex [get, set]
 Cache slice index to be used when caching option requires it. 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 RaiseEvent operation.

Constructor & Destructor Documentation

◆ RaiseEventRequest() [1/2]

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.

◆ RaiseEventRequest() [2/2]

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

Initializes a new instance of the RaiseEventRequest class.

Member Function Documentation

◆ DumpRequest()

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

◆ ValidateActorsList()

void Photon.Hive.Operations.RaiseEventRequest.ValidateActorsList ( int  currentActorsCount)
inline

Property Documentation

◆ Actors

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.

◆ Cache

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).

◆ CacheSliceIndex

int? Photon.Hive.Operations.RaiseEventRequest.CacheSliceIndex
getset

◆ Data

object Photon.Hive.Operations.RaiseEventRequest.Data
getset

Gets or sets the hashtable containing the data to send.

Optional request parameter.

◆ EvCode

byte Photon.Hive.Operations.RaiseEventRequest.EvCode
getset

Gets or sets a byte containing the Code to send.

Optional request parameter.

◆ Flush

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.

◆ GameId

string Photon.Hive.Operations.RaiseEventRequest.GameId
getset

Gets or sets the game id.

Optional request parameter.

◆ Group

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.

◆ HttpForward

bool? Photon.Hive.Operations.RaiseEventRequest.HttpForward
getset

◆ IsBroadcastOperation

bool Photon.Hive.Operations.RaiseEventRequest.IsBroadcastOperation
get

◆ IsCacheOnlyOperation

bool Photon.Hive.Operations.RaiseEventRequest.IsCacheOnlyOperation
get

◆ IsCacheOpRemoveFromCache

bool Photon.Hive.Operations.RaiseEventRequest.IsCacheOpRemoveFromCache
get

◆ IsCacheOpRemoveFromCacheForActorsLeft

bool Photon.Hive.Operations.RaiseEventRequest.IsCacheOpRemoveFromCacheForActorsLeft
get

◆ IsCacheSliceIndexOperation

bool Photon.Hive.Operations.RaiseEventRequest.IsCacheSliceIndexOperation
get

◆ OperationCode

byte Photon.Hive.Operations.RaiseEventRequest.OperationCode
get

◆ Parameters

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

◆ ReceiverGroup

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.

◆ SimulatesPhotonEvent

bool Photon.Hive.Operations.RaiseEventRequest.SimulatesPhotonEvent
get

◆ WebFlags

byte Photon.Hive.Operations.RaiseEventRequest.WebFlags
getset