Skip to content

QuantumGate::Peer::GetDetails

Karel Donk edited this page Dec 13, 2019 · 2 revisions

Gets information about the peer. This function is more efficient when you need to retrieve a number of different pieces of information about a peer at once. In that case use this function instead of the more specific member functions.

Signature

Result<Details> GetDetails() const noexcept;

Return values

Returns a QuantumGate::Result containing, upon successful completion, a QuantumGate::Peer::Details object with information about the peer.

The QuantumGate::Result object will equal one of the following QuantumGate::ResultCodes:

Value Description
QuantumGate::ResultCode::Succeeded The operation succeeded.
QuantumGate::ResultCode::PeerNotReady The operation failed because the peer wasn't ready. The connection to the peer may still be in the process of being established or may have been disconnected.

Clone this wiki locally