Photon Server API
Public Member Functions | Properties | List of all members
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...
 

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...
 
Dictionary< string, string > Header [get]
 
object InitObject [get]
 
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]
 
ushort SdkId [get]
 Sdk version More...
 
bool SourceUsingIPv6 [get]
 
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...
 

Detailed Description

Provides initialization request parameter.

Constructor & Destructor Documentation

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

Property Documentation

string Photon.SocketServer.InitRequest.ApplicationId
get

Gets the application id.

The application id.

Version Photon.SocketServer.InitRequest.ClientVersion
get

Gets the client version.

The client version.

int Photon.SocketServer.InitRequest.ConnectionId
get

Gets the connection id.

Peers connected to different ports may have similar connection ids.

Dictionary<string,string> Photon.SocketServer.InitRequest.Header
get
object Photon.SocketServer.InitRequest.InitObject
get
string Photon.SocketServer.InitRequest.LocalIP
get

Gets the local IP the client connected to.

int Photon.SocketServer.InitRequest.LocalPort
get

Gets the port the client connects to.

IPhotonPeer Photon.SocketServer.InitRequest.PhotonPeer
getset

Gets the native peer.

IRpcProtocol Photon.SocketServer.InitRequest.Protocol
get

Gets the used rpc protocol.

string Photon.SocketServer.InitRequest.RemoteIP
get

Gets the client's IP address.

int Photon.SocketServer.InitRequest.RemotePort
get

Gets the port the client connects from.

object Photon.SocketServer.InitRequest.ResponseObject
getset

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

ushort Photon.SocketServer.InitRequest.SdkId
get

Sdk version

bool Photon.SocketServer.InitRequest.SourceUsingIPv6
get
Uri Photon.SocketServer.InitRequest.Uri
get
object Photon.SocketServer.InitRequest.UserData
getset

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