Proud::CNetPeerInfo Class Reference

Public Member Functions
PROUD_API String	ToString (bool atServer)

Public Attributes
AddrPort	m_UdpAddrFromServer
AddrPort	m_UdpAddrInternal
HostID	m_HostID
bool	m_RelayedP2P
HostIDArray	m_joinedP2PGroups
bool	m_isBehindNat
int	m_recentPingMs
int	m_sendQueuedAmountInBytes
void *	m_hostTag
double	m_directP2PPeerFrameRate
uint32_t	m_toRemotePeerSendUdpMessageTrialCount
uint32_t	m_toRemotePeerSendUdpMessageSuccessCount
int64_t	m_unreliableMessageReceiveSpeed
int64_t	m_udpSendDataTotalBytes

Detailed Description

Information construct of opponent host

Member Data Documentation

double Proud::CNetPeerInfo::m_directP2PPeerFrameRate

Frame Rate of client

• User input value at CNetClient.SetApplicationHint
• It uses to check Frame Rate that each peers in P2P group
• You can use to select super peer with ping
• To reduce traffic, it sends/receives with float value

HostID Proud::CNetPeerInfo::m_HostID

Int of peer that allocated by CNetServer.

void* Proud::CNetPeerInfo::m_hostTag

Pointer of user defined tag

• A value set by CNetServer.SetHostTag and CNetClient.SetHostTag
• Attention!: tag is a value that cannot be network synchronized.

bool Proud::CNetPeerInfo::m_isBehindNat

If true then this client is behind NAT device

• Valid in both CNetServer and CNetClient

HostIDArray Proud::CNetPeerInfo::m_joinedP2PGroups

P2P group list that this client is participating

• Valid in both CNetServer and CNetClient

int Proud::CNetPeerInfo::m_recentPingMs

Recently measured the average time of ping (in Millisecond)

• If from CNetClient.GetPeerInfo: ping of the P2P peer
• If from CNetServer.GetClientInfo: ping between server and client

bool Proud::CNetPeerInfo::m_RelayedP2P

If true then RMI towards to peer of tis client P2P relayes.

• Only valid in CNetClient

int Proud::CNetPeerInfo::m_sendQueuedAmountInBytes

Total amount(in byte) of waiting messages to be sent to this peer

• If getting from peer by server: Total amount of transmission by client
• If getting from peer by client: Total amount of transmission by client (but excluding relayed messages)

uint32_t Proud::CNetPeerInfo::m_toRemotePeerSendUdpMessageSuccessCount

Total succeed number of sending Udp packet from CNetClient to other client

uint32_t Proud::CNetPeerInfo::m_toRemotePeerSendUdpMessageTrialCount

Total attempted number of sending Udp packet from CNetClient to other client

AddrPort Proud::CNetPeerInfo::m_UdpAddrFromServer

Address of TCP socket of peer from server perspective. In other words, recognized address after finished t hole-punching from client to server.

• We recommend to understand Earning hole-punched address of client and Communicating with a separated UDP socket based on ProudNet hole-punched information without using ProudNet. first.
• The client jsut completed connecting to server has AddrPort.Unassigned value and changed to have hole-punched value within seconds. That means depending ontype and/or settings of router, the hole-punching can never be successful. If this happens, the value can remain as the value of AddrPort.Unassigned.
• This value does not necessarily mean the address of P2P hole-punched client address. The value is managed internally by engine.

AddrPort Proud::CNetPeerInfo::m_UdpAddrInternal

Address of UDP socket inside of peer

• The client that has not comp[leted UDP hole-punching with server, in other words the client communicating only through TCP can have this value as unassigned. But this is not abnormal situation.

int64_t Proud::CNetPeerInfo::m_udpSendDataTotalBytes

The number of total bytes that transmits the UDP data