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

Inheritance diagram for Photon.Chat.ChatPeer:

Public Member Functions
	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...

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()

Photon.Chat.ChatPeer.ChatPeer	(	IPhotonPeerListener	listener,
		ConnectionProtocol	protocol
	)

Chat Peer constructor.

Parameters

listener	Chat listener implementation.
protocol	Protocol to be used by the peer.

Member Function Documentation

◆ AuthenticateOnNameServer()

bool Photon.Chat.ChatPeer.AuthenticateOnNameServer	(	string	appId,
		string	appVersion,
		string	region,
		AuthenticationValues	authValues
	)

Authenticates on NameServer.

Returns: If the authentication operation request could be sent.

◆ Connect()

bool Photon.Chat.ChatPeer.Connect ( )

Connects to NameServer.

Returns: If the connection attempt could be sent.

Member Data Documentation

◆ NameServerHost

string Photon.Chat.ChatPeer.NameServerHost = "ns.photonengine.io"

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

◆ NameServerPortOverride

ushort Photon.Chat.ChatPeer.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 Photon.Chat.ChatPeer.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.

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

3rd-Party/Photon/PhotonChat/Code/ChatPeer.cs

Public Member Functions

Public Attributes

Properties