CConnman::DisconnectNode

DisconnectNode overloads

Synopses

Declared in <net.h>

Disconnect the peer with the given id, returning whether it was found.

[[requires_capability(0x7f2e2b74a068), requires_capability(0x7f2e28942d78), requires_capability(0x7f2e234d1f58), requires_capability(0x7f2e2737e6f8), requires_capability(0x7f2e235efd88), requires_capability(0x7f2e2a34be78), requires_capability(0x7f2e219f8c48), requires_capability(0x7f2e21c83b08), requires_capability(0x7f2e1aa36668), requires_capability(0x7f2e376b8748), requires_capability(0x7f2e433ce2d8)]]
bool
DisconnectNode(NodeId id);
» more...

Disconnect the peer(s) matching the given node string, returning whether any matched.

[[requires_capability(0x7f2e2b749ca8), requires_capability(0x7f2e289429b8), requires_capability(0x7f2e234d1b98), requires_capability(0x7f2e2737e338), requires_capability(0x7f2e235ef9c8), requires_capability(0x7f2e2a34bab8), requires_capability(0x7f2e219f8888), requires_capability(0x7f2e21c83748), requires_capability(0x7f2e1aa362a8), requires_capability(0x7f2e376b8388), requires_capability(0x7f2e433cdf18)]]
bool
DisconnectNode(std::string_view node);
» more...

Disconnect all peers at the given address, returning whether any matched.

[[requires_capability(0x7f2e2b749f28), requires_capability(0x7f2e28942c38), requires_capability(0x7f2e234d1e18), requires_capability(0x7f2e2737e5b8), requires_capability(0x7f2e235efc48), requires_capability(0x7f2e2a34bd38), requires_capability(0x7f2e219f8b08), requires_capability(0x7f2e21c839c8), requires_capability(0x7f2e1aa36528), requires_capability(0x7f2e376b8608), requires_capability(0x7f2e433ce198)]]
bool
DisconnectNode(CNetAddr const& addr);
» more...

Disconnect all peers within the given subnet, returning whether any matched.

[[requires_capability(0x7f2e2b749de8), requires_capability(0x7f2e28942af8), requires_capability(0x7f2e234d1cd8), requires_capability(0x7f2e2737e478), requires_capability(0x7f2e235efb08), requires_capability(0x7f2e2a34bbf8), requires_capability(0x7f2e219f89c8), requires_capability(0x7f2e21c83888), requires_capability(0x7f2e1aa363e8), requires_capability(0x7f2e376b84c8), requires_capability(0x7f2e433ce058)]]
bool
DisconnectNode(CSubNet const& subnet);
» more...

Return Value

  • true if the peer was found and disconnected.
  • true if at least one peer was disconnected.

Parameters

NameDescription
idthe id of the peer to disconnect.
nodethe host string identifying the peer(s) to disconnect.
addrthe address whose peers should be disconnected.
subnetthe subnet whose peers should be disconnected.