Skip to content

QuantumGate::Peer::GetRelayed

Karel Donk edited this page Aug 16, 2020 · 1 revision

Checks whether or not the connection to the peer is relayed.

Signature

Result<bool> GetRelayed() const noexcept;

Return values

Returns a QuantumGate::Result containing, upon successful completion, a bool value indicating whether the connection to the peer is relayed (true) or not (false).

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