Photon.SocketServer.InitRequest Class Reference

Provides initialization request parameter. More...

Public Member Functions
	InitRequest (IRpcProtocol protocol, IPhotonPeer peer)
	constructor which helps create test peers DO NOT USE IT IN REAL ENVIRONMENT More...
	InitRequest (IRpcProtocol protocol, Version clientLibVersion, byte sdkid, byte platformId, bool debug, bool usingIPv6, byte[] initRequest)
string	GetInfoAsString ()
void	RejectWithDelayedResponse (short errorCode=ErrorCodes.NotReady, string debugMsg=ErrorMessages.ServerNotReady, int responseDelay=0)

Properties
string	ApplicationId [get]
	Gets the application id. More...
Version	ClientVersion [get]
	Gets the client version. More...
int	ConnectionId [get]
	Gets the connection id. More...
object	InitObject [get]
	Init object which was sent by client during connection establishing More...
object	DecryptedAuthToken [get]
	Decrypted by application auth token More...
string	LocalIP [get]
	Gets the local IP the client connected to. More...
int	LocalPort [get]
	Gets the port the client connects to. More...
IPhotonPeer	PhotonPeer [get, set]
	Gets the native peer. More...
IRpcProtocol	Protocol [get]
	Gets the used rpc protocol. More...
string	RemoteIP [get]
	Gets the client's IP address. More...
int	RemotePort [get]
	Gets the port the client connects from. More...
Uri	Uri [get]
	Requested URL More...
byte	SdkId [get]
	Sdk version More...
byte	PlatformId [get, set]
	Platform on which sdk is used More...
bool	ClientUsingDebugLib [get]
	Shows whether debug version of client lib is used More...
bool	SourceUsingIPv6 [get]
	If true indicates that client uses IPv6 More...
object	ResponseObject [get, set]
	Response object - data which will be sent to client as response to init request More...
object	UserData [get, set]
	Any user data object which might be set and used during peer initialization More...
WebHeaderCollection	HttpHeaders [get]
	Headers of http request More...
InitV3Response	InitResponse [get, set]
	Init V3 response. can be used to send init (handshake) response to client with custom errors and debug string in case if InitV3 is used More...
bool	IsInitV3Used [get]
NetworkProtocolType	NetworkProtocol [get]
PeerType	PeerType [get]
byte	ChannelCount [get, set]
bool	IsRejected [get]
bool	IsRejectWithDelayedResponse [get]
int	ResponseDelay [get]

Detailed Description

Provides initialization request parameter.

Constructor & Destructor Documentation

InitRequest() [1/2]

Photon.SocketServer.InitRequest.InitRequest ( IRpcProtocol  protocol, IPhotonPeer  peer  )

inline

constructor which helps create test peers DO NOT USE IT IN REAL ENVIRONMENT

Parameters

protocol
peer

InitRequest() [2/2]

Photon.SocketServer.InitRequest.InitRequest ( IRpcProtocol  protocol, Version  clientLibVersion, byte  sdkid, byte  platformId, bool  debug, bool  usingIPv6, byte[]  initRequest  )

inline

Member Function Documentation

GetInfoAsString()

string Photon.SocketServer.InitRequest.GetInfoAsString ( )

inline

RejectWithDelayedResponse()

void Photon.SocketServer.InitRequest.RejectWithDelayedResponse ( short  errorCode = ErrorCodes.NotReady, string  debugMsg = ErrorMessages.ServerNotReady, int  responseDelay = 0  )

inline

Property Documentation

ApplicationId

string Photon.SocketServer.InitRequest.ApplicationId

get

Gets the application id.

The application id.

ChannelCount

byte Photon.SocketServer.InitRequest.ChannelCount

getset

ClientUsingDebugLib

bool Photon.SocketServer.InitRequest.ClientUsingDebugLib

get

Shows whether debug version of client lib is used

ClientVersion

Version Photon.SocketServer.InitRequest.ClientVersion

get

Gets the client version.

The client version.

ConnectionId

int Photon.SocketServer.InitRequest.ConnectionId

get

Gets the connection id.

Peers connected to different ports may have similar connection ids.

DecryptedAuthToken

object Photon.SocketServer.InitRequest.DecryptedAuthToken

get

Decrypted by application auth token

HttpHeaders

WebHeaderCollection Photon.SocketServer.InitRequest.HttpHeaders

get

Headers of http request

InitObject

object Photon.SocketServer.InitRequest.InitObject

get

Init object which was sent by client during connection establishing

InitResponse

InitV3Response Photon.SocketServer.InitRequest.InitResponse

getset

Init V3 response. can be used to send init (handshake) response to client with custom errors and debug string in case if InitV3 is used

IsInitV3Used

bool Photon.SocketServer.InitRequest.IsInitV3Used

get

IsRejected

bool Photon.SocketServer.InitRequest.IsRejected

get

IsRejectWithDelayedResponse

bool Photon.SocketServer.InitRequest.IsRejectWithDelayedResponse

get

LocalIP

string Photon.SocketServer.InitRequest.LocalIP

get

Gets the local IP the client connected to.

LocalPort

int Photon.SocketServer.InitRequest.LocalPort

get

Gets the port the client connects to.

NetworkProtocol

NetworkProtocolType Photon.SocketServer.InitRequest.NetworkProtocol

get

PeerType

PeerType Photon.SocketServer.InitRequest.PeerType

get

PhotonPeer

IPhotonPeer Photon.SocketServer.InitRequest.PhotonPeer

getset

Gets the native peer.

PlatformId

byte Photon.SocketServer.InitRequest.PlatformId

getset

Platform on which sdk is used

Protocol

IRpcProtocol Photon.SocketServer.InitRequest.Protocol

get

Gets the used rpc protocol.

RemoteIP

string Photon.SocketServer.InitRequest.RemoteIP

get

Gets the client's IP address.

RemotePort

int Photon.SocketServer.InitRequest.RemotePort

get

Gets the port the client connects from.

ResponseDelay

int Photon.SocketServer.InitRequest.ResponseDelay

get

ResponseObject

object Photon.SocketServer.InitRequest.ResponseObject

getset

Response object - data which will be sent to client as response to init request

SdkId

byte Photon.SocketServer.InitRequest.SdkId

get

Sdk version

SourceUsingIPv6

bool Photon.SocketServer.InitRequest.SourceUsingIPv6

get

If true indicates that client uses IPv6

Uri

Uri Photon.SocketServer.InitRequest.Uri

get

Requested URL

UserData

object Photon.SocketServer.InitRequest.UserData

getset

Any user data object which might be set and used during peer initialization