Photon Bolt Engine API 1.3

Classes | Enumerations
UdpKit Namespace Reference

Classes

class  UdpPacket
 
class  UdpSession
 Base class for a UDPKit session. This class represents a session that can be used as starting point for a connection when Direct IP connection is not available. More...
 
class  UdpSessionFilter
 Used to filter only specific sessions that agree with the desired parameters when joining a session in a random fashion. More...
 

Enumerations

enum  UdpConnectionDisconnectReason {
  UdpConnectionDisconnectReason.Unknown = 0, UdpConnectionDisconnectReason.Timeout = 1, UdpConnectionDisconnectReason.Error = 2, UdpConnectionDisconnectReason.Disconnected = 3,
  UdpConnectionDisconnectReason.Authentication = 4, UdpConnectionDisconnectReason.MaxCCUReached = 5
}
 Reason why a connection got disconnected More...
 
enum  UdpConnectionType { UdpConnectionType.Unknown = 0, UdpConnectionType.Direct = 1, UdpConnectionType.Relayed = 2 }
 
enum  UdpSessionError {
  UdpSessionError.Ok, UdpSessionError.GameIdAlreadyExists, UdpSessionError.GameFull, UdpSessionError.GameClosed,
  UdpSessionError.GameDoesNotExist, UdpSessionError.Error
}
 Udp Session Error Enum More...
 
enum  UdpSessionFillMode : byte { UdpSessionFillMode.Fill, UdpSessionFillMode.Serial, UdpSessionFillMode.Random }
 Determines how the Sessions are filled with new players when the peer joins the session in a random fashion More...
 
enum  UdpSessionSource { UdpSessionSource.Lan, UdpSessionSource.Photon, UdpSessionSource.None }
 UDP session source. More...
 

Enumeration Type Documentation

◆ UdpConnectionDisconnectReason

Reason why a connection got disconnected

Enumerator
Unknown 

Unknown reason (should never happen)

Timeout 

Remote end timed out (connection was lost)

Error 

Internal socket error (corrupted sequence numbers, send window overflowed, etc.)

Disconnected 

Normal disconnect triggered by user code

Authentication 

The peer failed to authenticate on any step

MaxCCUReached 

The max connection limit with the cloud service was reached

◆ UdpConnectionType

Enumerator
Unknown 

Unkown connection type, represents an invalid connection (should never happen)

Direct 

Represents a connection that has direct connectivity with the other end

Relayed 

Represents a connection that makes use of a relay to maintain the connectivity with the other end

◆ UdpSessionError

Udp Session Error Enum

Enumerator
Ok 

OK

GameIdAlreadyExists 

A game with same ID already exists

GameFull 

The game server is full

GameClosed 

The game server is closed

GameDoesNotExist 

The game with the ID was not found

Error 

Generic error

◆ UdpSessionFillMode

enum UdpKit.UdpSessionFillMode : byte
strong

Determines how the Sessions are filled with new players when the peer joins the session in a random fashion

Enumerator
Fill 

Fills up rooms (oldest first) to get players together as fast as possible. Default.

Serial 

Distributes players across available rooms sequentially but takes filter into account. Without filter, rooms get players evenly distributed.

Random 

Joins a (fully) random room. Expected properties must match but aside from this, any available room might be selected.

◆ UdpSessionSource

UDP session source.

Enumerator
Lan 

LAN Source

Photon 

Photon Service Source

None 

None of the other source