|
| ChatPeer (IPhotonPeerListener listener, ConnectionProtocol protocol) |
| Chat Peer constructor. More...
|
|
bool | Connect () |
| Connects to NameServer. More...
|
|
bool | AuthenticateOnNameServer (string appId, string appVersion, string region, AuthenticationValues authValues) |
| Authenticates on NameServer. More...
|
|
string | CommandLogToString () |
| Obsolete and ignored. Converts the CommandLog into a readable table-like string with summary. More...
|
|
void | TrafficStatsReset () |
| Creates new instances of TrafficStats and starts a new timer for those. More...
|
|
string | VitalStatsToString (bool all) |
| Returns a string of the most interesting connection statistics. When you have issues on the client side, these might contain hints about the issue's cause. More...
|
|
| PhotonPeer (ConnectionProtocol protocolType) |
| Creates a new PhotonPeer with specified transport protocol (without a IPhotonPeerListener). More...
|
|
| PhotonPeer (IPhotonPeerListener listener, ConnectionProtocol protocolType) |
| Creates a new PhotonPeer instance to communicate with Photon and selects the transport protocol. We recommend UDP. More...
|
|
virtual bool | Connect (string serverAddress, string appId, object custom=null) |
| Starts connecting to the given Photon server. Non-blocking. More...
|
|
virtual bool | Connect (string serverAddress, string proxyServerAddress, string appId, object custom) |
| Starts connecting to the given Photon server. Non-blocking. More...
|
|
virtual void | Disconnect () |
| This method initiates a mutual disconnect between this client and the server. More...
|
|
virtual void | StopThread () |
| This method immediately closes a connection (pure client side) and ends related listening Threads. More...
|
|
virtual void | FetchServerTimestamp () |
| This will fetch the server's timestamp and update the approximation for property ServerTimeInMilliseconds. More...
|
|
bool | EstablishEncryption () |
| This method creates a public key for this client and exchanges it with the server. More...
|
|
bool | InitDatagramEncryption (byte[] encryptionSecret, byte[] hmacSecret, bool randomizedSequenceNumbers=false, bool chaningModeGCM=false) |
| Initializes Datagram Encryption. Optionally, the EncryptorType is being used, if set. More...
|
|
void | InitPayloadEncryption (byte[] secret) |
| Photon's Payload Encryption secret may be set by a response from the server. More...
|
|
virtual void | Service () |
| This method excutes DispatchIncomingCommands and SendOutgoingCommands in your application Thread-context. More...
|
|
virtual bool | SendOutgoingCommands () |
| Creates and sends a UDP/TCP package with outgoing commands (operations and acknowledgements). Also called by Service(). More...
|
|
virtual bool | SendAcksOnly () |
|
virtual bool | DispatchIncomingCommands () |
| Dispatching received messages (commands), causes callbacks for events, responses and state changes within a IPhotonPeerListener. More...
|
|
virtual bool | SendOperation (byte operationCode, Dictionary< byte, object > operationParameters, SendOptions sendOptions) |
| Prepares your operation (code and parameters) to be sent to the Photon Server with specified SendOptions. More...
|
|
virtual bool | SendOperation (byte operationCode, ParameterDictionary operationParameters, SendOptions sendOptions) |
|
|
string | NameServerAddress [get] |
| Name Server Address for Photon Cloud (based on current protocol). You can use the default values and usually won't have to set this value. More...
|
|
int | CommandBufferSize [get, set] |
| No effect anymore. Removed without replacement. More...
|
|
int | LimitOfUnreliableCommands [get, set] |
| No effect anymore. Removed without replacement. More...
|
|
int | LocalTimeInMilliSeconds [get] |
| Gets a local timestamp in milliseconds by calling SupportClass.GetTickCount(). See LocalMsTimestampDelegate. More...
|
|
string | ClientVersion [get] |
| Version of this library as string. More...
|
|
static bool | NativeSocketLibAvailable [get] |
| Checks if a native library for network sockets (PhotonSocketPlugin.dll) is available. To use it, see remarks. More...
|
|
static bool | NativePayloadEncryptionLibAvailable [get] |
| Checks if native library for Payload Encryption (PhotonCryptoPlugin.dll) is available. Used automatically. More...
|
|
static bool | NativeDatagramEncryptionLibAvailable [get] |
| Checks if a native library for Datagram Encryption is available. To use it, see remarks. More...
|
|
SerializationProtocol | SerializationProtocolType [get, set] |
| Enables selection of a (Photon-)serialization protocol. Used in Connect methods. More...
|
|
Type | SocketImplementation [get, set] |
| Can be used to read the IPhotonSocket implementation at runtime (before connecting). More...
|
|
IPhotonPeerListener | Listener [get, protected set] |
| Gets the IPhotonPeerListener of this instance (set in constructor). Can be used in derived classes for Listener.DebugReturn(). More...
|
|
bool | ReuseEventInstance [get, set] |
| Option to make the PhotonPeer reuse a single EventData instance for all incoming events. More...
|
|
bool | UseByteArraySlicePoolForEvents [get, set] |
| Enables a deserialization optimization for incoming events. Defaults to false. More...
|
|
bool | WrapIncomingStructs [get, set] |
| Incoming struct types are wrapped in a pooled IWrapperStruct, rather than being cast to object. This eliminated allocations and garbage collection from boxing, however object that are wrapped structs will need to be cast to WrapperStruct<T> and their values extracted with (obj as WrapperStruct<T>).Value. More...
|
|
ByteArraySlicePool | ByteArraySlicePool [get] |
| Instance of a ByteArraySlicePool. UseByteArraySlicePoolForEvents defines if this PhotonPeer is using the pool for deserialization of byte[] in Photon events. More...
|
|
long | BytesIn [get] |
| Gets count of all bytes coming in (including headers, excluding UDP/TCP overhead) More...
|
|
long | BytesOut [get] |
| Gets count of all bytes going out (including headers, excluding UDP/TCP overhead) More...
|
|
int | ByteCountCurrentDispatch [get] |
| Gets the size of the dispatched event or operation-result in bytes. This value is set before OnEvent() or OnOperationResponse() is called (within DispatchIncomingCommands()). More...
|
|
string? | CommandInfoCurrentDispatch [get] |
| Returns the debug string of the event or operation-response currently being dispatched or string. Empty if none. More...
|
|
int | ByteCountLastOperation [get] |
| Gets the size of the last serialized operation call in bytes. The value includes all headers for this single operation but excludes those of UDP, Enet Package Headers and TCP. More...
|
|
bool | EnableServerTracing [get, set] |
| Debugging option to tell the Photon Server to log all datagrams. More...
|
|
byte | QuickResendAttempts [get, set] |
| Up to 4 resend attempts for a reliable command can be done in quick succession (after RTT+4*Variance). More...
|
|
PeerStateValue | PeerState [get] |
| This is the (low level) state of the connection to the server of a PhotonPeer. Managed internally and read-only. More...
|
|
string | PeerID [get] |
| This peer's ID as assigned by the server or 0 if not using UDP. Will be 0xFFFF before the client connects. More...
|
|
int | QueuedIncomingCommands [get] |
| Count of all currently received but not-yet-Dispatched reliable commands (events and operation results) from all channels. More...
|
|
int | QueuedOutgoingCommands [get] |
| Count of all commands currently queued as outgoing, including all channels and reliable, unreliable. More...
|
|
bool | CrcEnabled [get, set] |
| While not connected, this controls if the next connection(s) should use a per-package CRC checksum. More...
|
|
int | PacketLossByCrc [get] |
| Count of packages dropped due to failed CRC checks for this connection. More...
|
|
int | PacketLossByChallenge [get] |
| Count of packages dropped due to wrong challenge for this connection. More...
|
|
int | SentReliableCommandsCount [get] |
| Gets the count of sent but not yet acknowledged commands (for UDP connections). More...
|
|
int? | ResentReliableCommands [get] |
| Count of commands that got repeated (due to local repeat-timing before an ACK was received). More...
|
|
int | DisconnectTimeout [get, set] |
| Time in milliseconds before any sent reliable command triggers a timeout disconnect, unless acknowledged by the receiver. Default: 10000. More...
|
|
int? | ServerTimeInMilliSeconds [get] |
| Approximated Environment.TickCount value of server (while connected). More...
|
|
SupportClass.IntegerMillisecondsDelegate | LocalMsTimestampDelegate [set] |
| This setter for the (local-) timestamp delegate replaces the default Environment.TickCount with any equal function. More...
|
|
int | ConnectionTime [get] |
| The internally used "per connection" time value, which is updated infrequently, when the library executes some connectio-related tasks. More...
|
|
int | LastSendAckTime [get] |
| The last ConnectionTime value, when some ACKs were sent out by this client. More...
|
|
int | LastSendOutgoingTime [get] |
| The last ConnectionTime value, when SendOutgoingCommands actually checked outgoing queues to send them. Must be connected. More...
|
|
int | LongestSentCall [get, set] |
| Measures the maximum milliseconds spent in PhotonSocket.Send(). More...
|
|
int | RoundTripTime [get] |
| Time until a reliable command is acknowledged by the server. More...
|
|
int | RoundTripTimeVariance [get] |
| Changes of the roundtriptime as variance value. Gives a hint about how much the time is changing. More...
|
|
int | LastRoundTripTime [get] |
| The last measured roundtrip time for this connection. More...
|
|
int | TimestampOfLastSocketReceive [get] |
| Timestamp of the last time anything (!) was received from the server (including low level Ping, ACKs, events and operation-returns). More...
|
|
string | ServerAddress [get] |
| The server address which was used in PhotonPeer.Connect() or null (before Connect() was called). More...
|
|
string | ServerIpAddress [get] |
| Contains the IP address of the previously resolved ServerAddress (or empty, if address wasn't resolved with the internal methods). More...
|
|
ConnectionProtocol | UsedProtocol [get] |
| The protocol this peer is currently connected/connecting with (or 0). More...
|
|
ConnectionProtocol | TransportProtocol [get, set] |
| This is the transport protocol to be used for next connect (see remarks). More...
|
|
virtual bool | IsSimulationEnabled [get, set] |
| Gets or sets the network simulation "enabled" setting. Changing this value also locks this peer's sending and when setting false, the internally used queues are executed (so setting to false can take some cycles). More...
|
|
NetworkSimulationSet | NetworkSimulationSettings [get] |
| Gets the settings for built-in Network Simulation for this peer instance while IsSimulationEnabled will enable or disable them. Once obtained, the settings can be modified by changing the properties. More...
|
|
int | MaximumTransferUnit [get, set] |
| The Maximum Trasfer Unit (MTU) defines the (network-level) packet-content size that is guaranteed to arrive at the server in one piece. The Photon Protocol uses this size to split larger data into packets and for receive-buffers of packets. More...
|
|
bool | IsEncryptionAvailable [get] |
| This property is set internally, when OpExchangeKeysForEncryption successfully finished. While it's true, encryption can be used for operations. More...
|
|
bool | IsSendingOnlyAcks [get, set] |
| While true, the peer will not send any other commands except ACKs (used in UDP connections). More...
|
|
TrafficStats | TrafficStatsIncoming [get, set] |
| Gets the byte-count of incoming "low level" messages, which are either Enet Commands or Tcp Messages. These include all headers, except those of the underlying internet protocol Udp or Tcp. More...
|
|
TrafficStats | TrafficStatsOutgoing [get, set] |
| Gets the byte-count of outgoing "low level" messages, which are either Enet Commands or Tcp Messages. These include all headers, except those of the underlying internet protocol Udp or Tcp. More...
|
|
TrafficStatsGameLevel | TrafficStatsGameLevel [get, set] |
| Gets a statistic of incoming and outgoing traffic, split by operation, operation-result and event. More...
|
|
long? | TrafficStatsElapsedMs [get] |
| Returns the count of milliseconds the stats are enabled for tracking. More...
|
|
bool | TrafficStatsEnabled [get, set] |
| Enables or disables collection of statistics in TrafficStatsIncoming, TrafficStatsOutgoing and TrafficstatsGameLevel. More...
|
|
Type | EncryptorType [get, set] |
| Setter for the Datagram Encryptor instance. Used at next connect. More...
|
|
int | CountDiscarded [get, set] |
| Count of unreliable commands being discarded in case this client already dispatched a command that was newer (higher sequence number). More...
|
|
int | DeltaUnreliableNumber [get, set] |
| Set per dispatch in DispatchIncomingCommands to: commandUnreliableSequenceNumber - channel.incomingUnreliableSequenceNumber. Indicates how big the (sequence)gap is, compared to the last dispatched unreliable command. More...
|
|