DisconnectNode overloads

Synopses

Declared in <net.h>

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

[[requires_capability(0x7ff36f7827c8), requires_capability(0x7ff36f469038), requires_capability(0x7ff37f4085f8), requires_capability(0x7ff3775653c8), requires_capability(0x7ff37b6a08c8), requires_capability(0x7ff37e1c84f8), requires_capability(0x7ff379a7ea48), requires_capability(0x7ff36f4a5a88), requires_capability(0x7ff37bc166e8), requires_capability(0x7ff3814a66b8), requires_capability(0x7ff3666cd738)]]
bool
DisconnectNode(NodeId id);

» more...

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

[[requires_capability(0x7ff36f782408), requires_capability(0x7ff36f468c78), requires_capability(0x7ff37f408238), requires_capability(0x7ff377565008), requires_capability(0x7ff37b6a0508), requires_capability(0x7ff37e1c8138), requires_capability(0x7ff379a7e688), requires_capability(0x7ff36f4a56c8), requires_capability(0x7ff37bc16328), requires_capability(0x7ff3814a62f8), requires_capability(0x7ff3666cd378)]]
bool
DisconnectNode(std::string_view node);

» more...

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

[[requires_capability(0x7ff36f782688), requires_capability(0x7ff36f468ef8), requires_capability(0x7ff37f4084b8), requires_capability(0x7ff377565288), requires_capability(0x7ff37b6a0788), requires_capability(0x7ff37e1c83b8), requires_capability(0x7ff379a7e908), requires_capability(0x7ff36f4a5948), requires_capability(0x7ff37bc165a8), requires_capability(0x7ff3814a6578), requires_capability(0x7ff3666cd5f8)]]
bool
DisconnectNode(CNetAddr const& addr);

» more...

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

[[requires_capability(0x7ff36f782548), requires_capability(0x7ff36f468db8), requires_capability(0x7ff37f408378), requires_capability(0x7ff377565148), requires_capability(0x7ff37b6a0648), requires_capability(0x7ff37e1c8278), requires_capability(0x7ff379a7e7c8), requires_capability(0x7ff36f4a5808), requires_capability(0x7ff37bc16468), requires_capability(0x7ff3814a6438), requires_capability(0x7ff3666cd4b8)]]
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

Name

Description

id

the id of the peer to disconnect.

node

the host string identifying the peer(s) to disconnect.

addr

the address whose peers should be disconnected.

subnet

the subnet whose peers should be disconnected.

Created with MrDocs