Photon.Hive.Plugin.CallInfo Class Reference

Inheritance diagram for Photon.Hive.Plugin.CallInfo:

Public Member Functions
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
Action< string, Dictionary< byte, object > >	OnFail

Protected Member Functions
	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 ()

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

Constructor & Destructor Documentation

CallInfo()

Photon.Hive.Plugin.CallInfo.CallInfo ( CallCounter  counter, ILogger  logger, CallEnv  callEnv  )

inlineprotected

Member Function Documentation

Cancel()

void Photon.Hive.Plugin.CallInfo.Cancel ( )

inline

Continue()

void Photon.Hive.Plugin.CallInfo.Continue ( )

inline

Implements Photon.Hive.Plugin.ICallInfo.

Defer()

void Photon.Hive.Plugin.CallInfo.Defer ( )

inline

Fail()

void Photon.Hive.Plugin.CallInfo.Fail ( string  msg = null, Dictionary< byte, object >  errorData = null  )

inline

Implements Photon.Hive.Plugin.ICallInfo.

GetStrictModeErrorMsg()

string Photon.Hive.Plugin.CallInfo.GetStrictModeErrorMsg ( )

inlineprotected

InternalDefer()

virtual void Photon.Hive.Plugin.CallInfo.InternalDefer ( )

inlinevirtual

NoDeferringStrictModeCheck()

bool Photon.Hive.Plugin.CallInfo.NoDeferringStrictModeCheck ( out string  errorMsg )

inlineprotected

NoPause()

void Photon.Hive.Plugin.CallInfo.NoPause ( )

inlineprotected

Pause()

virtual void Photon.Hive.Plugin.CallInfo.Pause ( )

inlinevirtual

Reset()

void Photon.Hive.Plugin.CallInfo.Reset ( )

inline

StrictModeCheck()

virtual bool Photon.Hive.Plugin.CallInfo.StrictModeCheck ( out string  errorMsg )

inlineprotectedvirtual

Implements Photon.Hive.Plugin.ICallInfo.

StrictModeCheckWithDefer()

bool Photon.Hive.Plugin.CallInfo.StrictModeCheckWithDefer ( out string  errorMsg )

inlineprotected

SupportedPause()

void Photon.Hive.Plugin.CallInfo.SupportedPause ( )

inlineprotected

Member Data Documentation

OnFail

Action<string, Dictionary<byte, object> > Photon.Hive.Plugin.CallInfo.OnFail

Property Documentation

ActorNr

int Photon.Hive.Plugin.CallInfo.ActorNr

getset

Handler

RequestHandler Photon.Hive.Plugin.CallInfo.Handler

getset

IsCanceled

bool Photon.Hive.Plugin.CallInfo.IsCanceled

get

IsCancelled

bool Photon.Hive.Plugin.CallInfo.IsCancelled

get

IsDeferred

bool Photon.Hive.Plugin.CallInfo.IsDeferred

get

IsFailed

bool Photon.Hive.Plugin.CallInfo.IsFailed

get

IsNew

bool Photon.Hive.Plugin.CallInfo.IsNew

get

IsPaused

bool Photon.Hive.Plugin.CallInfo.IsPaused

get

IsProcessed

bool Photon.Hive.Plugin.CallInfo.IsProcessed

get

IsSucceeded

bool Photon.Hive.Plugin.CallInfo.IsSucceeded

get

OperationRequest

IOperationRequest Photon.Hive.Plugin.CallInfo.OperationRequest

getset

Peer

HivePeer Photon.Hive.Plugin.CallInfo.Peer

getset

SendParams

SocketServer.SendParameters Photon.Hive.Plugin.CallInfo.SendParams

getset

Status

byte Photon.Hive.Plugin.CallInfo.Status

getprotected set

Call processing status. For possible values, Photon.Hive.Plugin.CallStatus.