Photon Unity Networking 2 2.45

Public Member Functions | Public Attributes | Properties | List of all members
ChatPeer Class Reference

Provides basic operations of the Photon Chat server. This internal class is used by public ChatClient. More...

Inherits PhotonPeer.

Public Member Functions

 ChatPeer (IPhotonPeerListener listener, ConnectionProtocol protocol)
 Chat Peer constructor. More...
 
bool AuthenticateOnNameServer (string appId, string appVersion, string region, AuthenticationValues authValues)
 Authenticates on NameServer. More...
 

Public Attributes

string NameServerHost = "ns.photonengine.io"
 Name Server Host Name for Photon Cloud. Without port and without any prefix. More...
 
ushort NameServerPortOverride
 If not zero, this is used for the name server port on connect. Independent of protocol (so this better matches). Set by ChatClient.ConnectUsingSettings. More...
 

Properties

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...
 

Detailed Description

Provides basic operations of the Photon Chat server. This internal class is used by public ChatClient.

Constructor & Destructor Documentation

◆ ChatPeer()

ChatPeer ( IPhotonPeerListener  listener,
ConnectionProtocol  protocol 
)

Chat Peer constructor.

Parameters
listenerChat listener implementation.
protocolProtocol to be used by the peer.

Member Function Documentation

◆ AuthenticateOnNameServer()

bool AuthenticateOnNameServer ( string  appId,
string  appVersion,
string  region,
AuthenticationValues  authValues 
)

Authenticates on NameServer.

Returns
If the authentication operation request could be sent.

Member Data Documentation

◆ NameServerHost

string NameServerHost = "ns.photonengine.io"

Name Server Host Name for Photon Cloud. Without port and without any prefix.

◆ NameServerPortOverride

ushort NameServerPortOverride

If not zero, this is used for the name server port on connect. Independent of protocol (so this better matches). Set by ChatClient.ConnectUsingSettings.

This is reset when the protocol fallback is used.

Property Documentation

◆ NameServerAddress

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.