Skip to content

QuantumGate::Peer

Karel Donk edited this page Dec 26, 2021 · 8 revisions

QuantumGate::Peer is a class that represents a peer on the local QuantumGate instance. Using the constructor you can only create an empty QuantumGate::Peer object, but you can use the QuantumGate::Local::GetPeer() and QuantumGate::Extender::GetPeer() member functions to get a valid QuantumGate::Peer object that represents a connected peer to the local instance.

Member functions

General

Name Description
Constructor Constructs a QuantumGate::Peer object.
operator= Move assigns a value from another Peer.
operator bool Returns whether the object contains a valid peer.
HasPeer Returns whether the object contains a valid peer.
GetDetails Gets information about a peer such as the properties of the connection and IP addresses.

IDs

Name Description
GetLUID Gets the Locally Unique Identifier of the peer.
GetUUID Gets the Universally Unique Identifier of the peer on the QuantumGate network.
GetLocalSessionID Gets the local session ID.
GetPeerSessionID Gets the peer session ID.

Connection

Name Description
IsConnected Checks whether or not the peer is (still) connected to the local instance.
GetConnectionType Gets the connection type.
GetConnectionAlgorithms Gets the algorithms used during the connection to the peer.
GetConnectedTime Gets the number of milliseconds that the peer has been connected.
GetPeerProtocolVersion Gets the QuantumGate protocol version of the peer.
GetAuthenticated Checks whether or not the peer is authenticated.
GetRelayed Checks whether or not the connection to the peer is relayed.
GetSuspended Checks whether or not the connection to the peer is suspended.
GetUsingGlobalSharedSecret Checks whether or not a Global Shared Secret is used for the connection to the peer.
GetLocalEndpoint Gets the local endpoint of the peer.
GetPeerEndpoint Gets the remote endpoint of the peer.

Data Transfer

Name Description
GetBytesReceived Gets the number of bytes received from the peer.
GetBytesSent Gets the number of bytes sent to the peer.
GetExtendersBytesReceived Gets the number of bytes of extender data received from the peer.
GetExtendersBytesSent Gets the number of bytes of extender data sent to the peer.
Clone this wiki locally