Photon .NET Client API
Public Types | Public Member Functions | Public Attributes | Protected Attributes | Properties | List of all members
ExitGames.Client.Photon.PeerBase Class Referenceabstract

Inherited by ExitGames.Client.Photon.EnetPeer, and ExitGames.Client.Photon.TPeer.

Public Types

enum  ConnectionStateValue : byte {
  ConnectionStateValue.Disconnected = 0, ConnectionStateValue.Connecting = 1, ConnectionStateValue.Connected = 3, ConnectionStateValue.Disconnecting = 4,
  ConnectionStateValue.AcknowledgingDisconnect = 5, ConnectionStateValue.Zombie = 6
}
 This is the replacement for the const values used in eNet like: PS_DISCONNECTED, PS_CONNECTED, etc. More...
 

Public Member Functions

string CommandLogToString ()
 Converts the CommandLog into a readable table-like string with summary. More...
 

Public Attributes

const string ClientVersion = "4.0.0.12"
 
int ByteCountLastOperation
 
int ByteCountCurrentDispatch
 
TrafficStats TrafficStatsIncoming
 
TrafficStats TrafficStatsOutgoing
 
TrafficStatsGameLevel TrafficStatsGameLevel
 

Protected Attributes

Type SocketImplementation = null
 
MemoryStream SerializeMemStream = new MemoryStream()
 

Properties

long TrafficStatsEnabledTime [get]
 
bool TrafficStatsEnabled [get, set]
 Enables or disables collection of statistics. Setting this to true, also starts the stopwatch to measure the timespan the stats are collected. More...
 
string ServerAddress [get, set]
 
byte QuickResendAttempts [get, set]
 
NetworkSimulationSet NetworkSimulationSettings [get]
 Gets the currently used settings for the built-in network simulation. Please check the description of NetworkSimulationSet for more details. More...
 
virtual string PeerID [get]
 
byte[] TcpConnectionPrefix [get, set]
 

Member Enumeration Documentation

This is the replacement for the const values used in eNet like: PS_DISCONNECTED, PS_CONNECTED, etc.

Enumerator
Disconnected 

No connection is available. Use connect.

Connecting 

Establishing a connection already. The app should wait for a status callback.

Connected 

The low level connection with Photon is established. On connect, the library will automatically send an Init package to select the application it connects to (see also PhotonPeer.Connect()). When the Init is done, IPhotonPeerListener.OnStatusChanged() is called with connect.

Please note that calling operations is only possible after the OnStatusChanged() with StatusCode.Connect.

Disconnecting 

Connection going to be ended. Wait for status callback.

AcknowledgingDisconnect 

Acknowledging a disconnect from Photon. Wait for status callback.

Zombie 

Connection not properly disconnected.

Member Function Documentation

string ExitGames.Client.Photon.PeerBase.CommandLogToString ( )
inline

Converts the CommandLog into a readable table-like string with summary.

Member Data Documentation

int ExitGames.Client.Photon.PeerBase.ByteCountCurrentDispatch
int ExitGames.Client.Photon.PeerBase.ByteCountLastOperation
const string ExitGames.Client.Photon.PeerBase.ClientVersion = "4.0.0.12"
MemoryStream ExitGames.Client.Photon.PeerBase.SerializeMemStream = new MemoryStream()
protected
Type ExitGames.Client.Photon.PeerBase.SocketImplementation = null
protected
TrafficStatsGameLevel ExitGames.Client.Photon.PeerBase.TrafficStatsGameLevel
TrafficStats ExitGames.Client.Photon.PeerBase.TrafficStatsIncoming
TrafficStats ExitGames.Client.Photon.PeerBase.TrafficStatsOutgoing

Property Documentation

NetworkSimulationSet ExitGames.Client.Photon.PeerBase.NetworkSimulationSettings
get

Gets the currently used settings for the built-in network simulation. Please check the description of NetworkSimulationSet for more details.

virtual string ExitGames.Client.Photon.PeerBase.PeerID
get
byte ExitGames.Client.Photon.PeerBase.QuickResendAttempts
getset
string ExitGames.Client.Photon.PeerBase.ServerAddress
getset
byte [] ExitGames.Client.Photon.PeerBase.TcpConnectionPrefix
getsetprotected
bool ExitGames.Client.Photon.PeerBase.TrafficStatsEnabled
getset

Enables or disables collection of statistics. Setting this to true, also starts the stopwatch to measure the timespan the stats are collected.

long ExitGames.Client.Photon.PeerBase.TrafficStatsEnabledTime
get

The documentation for this class was generated from the following file: