Photon Server API Documentation v5.0RC1

Protected Member Functions | Static Protected Attributes | Properties | List of all members
Photon.Hive.Plugin.TypedCallInfo< RequestType > Class Template Reference
Inheritance diagram for Photon.Hive.Plugin.TypedCallInfo< RequestType >:
Photon.Hive.Plugin.CallInfo Photon.Hive.Plugin.ITypedCallInfo< RequestType > Photon.Hive.Plugin.ICallInfo

Protected Member Functions

 TypedCallInfo (CallCounter counter, ILogger logger, CallEnv env)
 
- Protected Member Functions inherited from Photon.Hive.Plugin.CallInfo
 CallInfo (CallCounter counter, ILogger logger, CallEnv callEnv)
 
virtual bool StrictModeCheck (out string errorMsg)
 
bool NoDeferringStrictModeCheck (out string errorMsg)
 
bool StrictModeCheckWithDefer (out string errorMsg)
 
string GetStrictModeErrorMsg ()
 
void SupportedPause ()
 
void NoPause ()
 

Static Protected Attributes

static readonly LogCountGuard onFailLogCountGuard = new LogCountGuard(new TimeSpan(0, 0, 3))
 

Properties

RequestType Request [get, set]
 
string UserId [get, set]
 
string Nickname [get, set]
 
object? AuthResultsToken [get]
 
Dictionary< string, object >? AuthCookie [get]
 
- Properties inherited from Photon.Hive.Plugin.CallInfo
int ActorNr [get, set]
 
RequestHandler Handler [get, set]
 
IOperationRequest OperationRequest [get, set]
 
byte Status [get, protected set]
 Call processing status. For possible values, Photon.Hive.Plugin.CallStatus. More...
 
bool IsNew [get]
 
bool IsPaused [get]
 
bool IsDeferred [get]
 
bool IsSucceeded [get]
 
bool IsFailed [get]
 
bool IsCanceled [get]
 
bool IsCancelled [get]
 
bool IsProcessed [get]
 
HivePeer Peer [get, set]
 
SocketServer.SendParameters SendParams [get, set]
 
- Properties inherited from Photon.Hive.Plugin.ICallInfo
IOperationRequest OperationRequest [get]
 The operation request triggering the callback call. More...
 
byte Status [get]
 Gets status of current call. I.E. whether it is new, deffered, failed, succeded or canceled More...
 
bool IsNew [get]
 Helper property to check if call is not processed nor deferred. More...
 
bool IsDeferred [get]
 Helper property to check if call is deferred. More...
 
bool IsSucceeded [get]
 Helper property to check if call was processed successfully (Continue() was called). More...
 
bool IsFailed [get]
 Helper property to check if Fail() was called. More...
 
bool IsCanceled [get]
 Helper property to check if Cancel() was called. More...
 
bool IsCancelled [get]
 
bool IsProcessed [get]
 Helper property to check if the call was processed using any of the three methods: Continue, Cancel or Fail. More...
 
bool IsPaused [get]
 Helper property to check if call is Paused More...
 
- Properties inherited from Photon.Hive.Plugin.ITypedCallInfo< RequestType >
RequestType Request [get]
 
string UserId [get]
 User ID of the actor triggering the call. More...
 
string Nickname [get]
 NickName of the actor triggering the call. More...
 
object AuthResultsToken [get]
 
Dictionary< string, object > AuthCookie [get]
 AuthCookie of the actor triggering the call. More...
 

Additional Inherited Members

- Public Member Functions inherited from Photon.Hive.Plugin.CallInfo
void Reset ()
 
virtual void Pause ()
 
virtual void InternalDefer ()
 
void Continue ()
 
void Fail (string msg=null, Dictionary< byte, object > errorData=null)
 
void Cancel ()
 
void Defer ()
 
- Public Attributes inherited from Photon.Hive.Plugin.CallInfo
Action< string, Dictionary< byte, object > > OnFail
 

Constructor & Destructor Documentation

◆ TypedCallInfo()

Photon.Hive.Plugin.TypedCallInfo< RequestType >.TypedCallInfo ( CallCounter  counter,
ILogger  logger,
CallEnv  env 
)
inlineprotected

Member Data Documentation

◆ onFailLogCountGuard

readonly LogCountGuard Photon.Hive.Plugin.TypedCallInfo< RequestType >.onFailLogCountGuard = new LogCountGuard(new TimeSpan(0, 0, 3))
staticprotected

Property Documentation

◆ AuthCookie

Dictionary<string, object>? Photon.Hive.Plugin.TypedCallInfo< RequestType >.AuthCookie
get

◆ AuthResultsToken

object? Photon.Hive.Plugin.TypedCallInfo< RequestType >.AuthResultsToken
get

◆ Nickname

string Photon.Hive.Plugin.TypedCallInfo< RequestType >.Nickname
getset

◆ Request

RequestType Photon.Hive.Plugin.TypedCallInfo< RequestType >.Request
getset

◆ UserId

string Photon.Hive.Plugin.TypedCallInfo< RequestType >.UserId
getset