Information about a peer. More...

#include <net.h>

Collaboration diagram for CNode:

Classes
struct	TxRelay

Public Member Functions
SOCKET hSocket	GUARDED_BY (cs_hSocket)

uint64_t nSendBytes	GUARDED_BY (cs_vSend)

std::deque< std::vector< unsigned char > > vSendMsg	GUARDED_BY (cs_vSend)

std::list< CNetMessage > vProcessMsg	GUARDED_BY (cs_vProcessMsg)

uint64_t nRecvBytes	GUARDED_BY (cs_vRecv)

std::string cleanSubVer	GUARDED_BY (cs_SubVer)
	cleanSubVer is a sanitized string of the user agent byte array we read from the wire. More...

bool	HasPermission (NetPermissionFlags permission) const

int64_t nNextAddrSend	GUARDED_BY (cs_sendProcessing)

int64_t nNextLocalAddrSend	GUARDED_BY (cs_sendProcessing)

bool	IsAddrRelayPeer () const

std::vector< uint256 > vInventoryBlockToSend	GUARDED_BY (cs_inventory)

std::vector< uint256 > vBlockHashesToAnnounce	GUARDED_BY (cs_inventory)

	CNode (NodeId id, ServiceFlags nLocalServicesIn, int nMyStartingHeightIn, SOCKET hSocketIn, const CAddress &addrIn, uint64_t nKeyedNetGroupIn, uint64_t nLocalHostNonceIn, const CAddress &addrBindIn, const std::string &addrNameIn="", bool fInboundIn=false, bool block_relay_only=false)

	~CNode ()

	CNode (const CNode &)=delete

CNode &	operator= (const CNode &)=delete

NodeId	GetId () const

uint64_t	GetLocalNonce () const

int	GetMyStartingHeight () const

int	GetRefCount () const

bool	ReceiveMsgBytes (const char *pch, unsigned int nBytes, bool &complete)

void	SetRecvVersion (int nVersionIn)

int	GetRecvVersion () const

void	SetSendVersion (int nVersionIn)

int	GetSendVersion () const

CService	GetAddrLocal () const

void	SetAddrLocal (const CService &addrLocalIn)
	May not be called more than once. More...

CNode *	AddRef ()

void	Release ()

void	AddAddressKnown (const CAddress &_addr)

void	PushAddress (const CAddress &_addr, FastRandomContext &insecure_rand)

void	AddInventoryKnown (const CInv &inv)

void	PushInventory (const CInv &inv)

void	PushBlockHash (const uint256 &hash)

void	CloseSocketDisconnect ()

void	copyStats (CNodeStats &stats, const std::vector< bool > &m_asmap)

ServiceFlags	GetLocalServices () const

std::string	GetAddrName () const

void	MaybeSetAddrName (const std::string &addrNameIn)
	Sets the addrName only if it was not previously set. More...

Public Attributes
std::unique_ptr< TransportDeserializer >	m_deserializer

std::atomic< ServiceFlags >	nServices {NODE_NONE}

size_t	nSendSize {0}

size_t	nSendOffset {0}

RecursiveMutex	cs_vSend

RecursiveMutex	cs_hSocket

RecursiveMutex	cs_vRecv

RecursiveMutex	cs_vProcessMsg

size_t	nProcessQueueSize {0}

RecursiveMutex	cs_sendProcessing

std::deque< CInv >	vRecvGetData

std::atomic< int >	nRecvVersion {INIT_PROTO_VERSION}

std::atomic< int64_t >	nLastSend {0}

std::atomic< int64_t >	nLastRecv {0}

const int64_t	nTimeConnected

std::atomic< int64_t >	nTimeOffset {0}

const CAddress	addr

const CAddress	addrBind

std::atomic< int >	nVersion {0}

RecursiveMutex	cs_SubVer

bool	m_prefer_evict {false}

bool	m_legacyWhitelisted {false}

bool	fFeeler {false}

bool	fOneShot {false}

bool	m_manual_connection {false}

bool	fClient {false}

bool	m_limited_node {false}

const bool	fInbound

std::atomic_bool	fSuccessfullyConnected {false}

std::atomic_bool	fDisconnect {false}

bool	fSentAddr {false}

CSemaphoreGrant	grantOutbound

std::atomic< int >	nRefCount {0}

const uint64_t	nKeyedNetGroup

std::atomic_bool	fPauseRecv {false}

std::atomic_bool	fPauseSend {false}

uint256	hashContinue

std::atomic< int >	nStartingHeight {-1}

std::vector< CAddress >	vAddrToSend

const std::unique_ptr< CRollingBloomFilter >	m_addr_known

bool	fGetAddr {false}

RecursiveMutex	cs_inventory

std::unique_ptr< TxRelay >	m_tx_relay

std::atomic< int64_t >	nLastBlockTime {0}

std::atomic< int64_t >	nLastTXTime {0}

std::atomic< uint64_t >	nPingNonceSent {0}

std::atomic< int64_t >	nPingUsecStart {0}

std::atomic< int64_t >	nPingUsecTime {0}

std::atomic< int64_t >	nMinPingUsecTime {std::numeric_limits<int64_t>::max()}

std::atomic< bool >	fPingQueued {false}

std::set< uint256 >	orphan_work_set

Protected Member Functions
mapMsgCmdSize mapRecvBytesPerMsgCmd	GUARDED_BY (cs_vRecv)

Protected Attributes
mapMsgCmdSize	mapSendBytesPerMsgCmd

Private Member Functions
std::string addrName	GUARDED_BY (cs_addrName)

CService addrLocal	GUARDED_BY (cs_addrLocal)

Private Attributes
const NodeId	id

const uint64_t	nLocalHostNonce

const ServiceFlags	nLocalServices
	Services offered to this peer. More...

const int	nMyStartingHeight

int	nSendVersion {0}

NetPermissionFlags	m_permissionFlags { PF_NONE }

std::list< CNetMessage >	vRecvMsg

RecursiveMutex	cs_addrName

RecursiveMutex	cs_addrLocal

Friends
class	CConnman

Detailed Description

Information about a peer.

Definition at line 707 of file net.h.

Constructor & Destructor Documentation

◆ CNode() [1/2]

CNode::CNode	(	NodeId	id,
		ServiceFlags	nLocalServicesIn,
		int	nMyStartingHeightIn,
		SOCKET	hSocketIn,
		const CAddress &	addrIn,
		uint64_t	nKeyedNetGroupIn,
		uint64_t	nLocalHostNonceIn,
		const CAddress &	addrBindIn,
		const std::string &	addrNameIn = `""`,
		bool	fInboundIn = `false`,
		bool	block_relay_only = `false`
	)

Definition at line 2675 of file net.cpp.

Here is the call graph for this function:

◆ ~CNode()

CNode::~CNode ( )

Definition at line 2710 of file net.cpp.

Here is the call graph for this function:

◆ CNode() [2/2]

CNode::CNode ( const CNode & )

delete

Member Function Documentation

◆ AddAddressKnown()

void CNode::AddAddressKnown ( const CAddress & _addr )

inline

Definition at line 935 of file net.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddInventoryKnown()

void CNode::AddInventoryKnown ( const CInv & inv )

inline

Definition at line 957 of file net.h.

Here is the caller graph for this function:

◆ AddRef()

CNode* CNode::AddRef ( )

inline

Definition at line 922 of file net.h.

Here is the caller graph for this function:

◆ CloseSocketDisconnect()

void CNode::CloseSocketDisconnect ( )

Definition at line 456 of file net.cpp.

Here is the call graph for this function:

◆ copyStats()

void CNode::copyStats	(	CNodeStats &	stats,
		const std::vector< bool > &	m_asmap
	)

Definition at line 501 of file net.cpp.

Here is the call graph for this function:

◆ GetAddrLocal()

CService CNode::GetAddrLocal ( ) const

Definition at line 485 of file net.cpp.

Here is the caller graph for this function:

◆ GetAddrName()

std::string CNode::GetAddrName ( ) const

Definition at line 473 of file net.cpp.

Here is the caller graph for this function:

◆ GetId()

NodeId CNode::GetId ( ) const

inline

Definition at line 887 of file net.h.

Here is the caller graph for this function:

◆ GetLocalNonce()

uint64_t CNode::GetLocalNonce ( ) const

inline

Definition at line 891 of file net.h.

◆ GetLocalServices()

ServiceFlags CNode::GetLocalServices ( ) const

inline

Definition at line 988 of file net.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMyStartingHeight()

int CNode::GetMyStartingHeight ( ) const

inline

Definition at line 895 of file net.h.

◆ GetRecvVersion()

int CNode::GetRecvVersion ( ) const

inline

Definition at line 911 of file net.h.

Here is the caller graph for this function:

◆ GetRefCount()

int CNode::GetRefCount ( ) const

inline

Definition at line 899 of file net.h.

◆ GetSendVersion()

int CNode::GetSendVersion ( ) const

Definition at line 619 of file net.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY() [1/13]

SOCKET hSocket CNode::GUARDED_BY ( cs_hSocket )

◆ GUARDED_BY() [2/13]

uint64_t nSendBytes CNode::GUARDED_BY ( cs_vSend )

inline

Definition at line 718 of file net.h.

Here is the call graph for this function:

◆ GUARDED_BY() [3/13]

std::deque<std::vector<unsigned char> > vSendMsg CNode::GUARDED_BY ( cs_vSend )

◆ GUARDED_BY() [4/13]

std::list<CNetMessage> vProcessMsg CNode::GUARDED_BY ( cs_vProcessMsg )

◆ GUARDED_BY() [5/13]

uint64_t nRecvBytes CNode::GUARDED_BY ( cs_vRecv )

inline

Definition at line 731 of file net.h.

◆ GUARDED_BY() [6/13]

std::string cleanSubVer CNode::GUARDED_BY ( cs_SubVer )

inline

cleanSubVer is a sanitized string of the user agent byte array we read from the wire.

This cleaned string can safely be logged or displayed.

Definition at line 748 of file net.h.

◆ GUARDED_BY() [7/13]

mapMsgCmdSize mapRecvBytesPerMsgCmd CNode::GUARDED_BY ( cs_vRecv )

protected

◆ GUARDED_BY() [8/13]

int64_t nNextAddrSend CNode::GUARDED_BY ( cs_sendProcessing )

inline

Definition at line 785 of file net.h.

◆ GUARDED_BY() [9/13]

int64_t nNextLocalAddrSend CNode::GUARDED_BY ( cs_sendProcessing )

inline

Definition at line 786 of file net.h.

◆ GUARDED_BY() [10/13]

std::vector<uint256> vInventoryBlockToSend CNode::GUARDED_BY ( cs_inventory )

◆ GUARDED_BY() [11/13]

std::vector<uint256> vBlockHashesToAnnounce CNode::GUARDED_BY ( cs_inventory )

◆ GUARDED_BY() [12/13]

std::string addrName CNode::GUARDED_BY ( cs_addrName )

private

◆ GUARDED_BY() [13/13]

CService addrLocal CNode::GUARDED_BY ( cs_addrLocal )

private

◆ HasPermission()

bool CNode::HasPermission ( NetPermissionFlags permission ) const

inline

Definition at line 750 of file net.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsAddrRelayPeer()

bool CNode::IsAddrRelayPeer ( ) const

inline

Definition at line 788 of file net.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MaybeSetAddrName()

void CNode::MaybeSetAddrName ( const std::string & addrNameIn )

Sets the addrName only if it was not previously set.

Definition at line 478 of file net.cpp.

Here is the caller graph for this function:

◆ operator=()

CNode& CNode::operator= ( const CNode & )

delete

◆ PushAddress()

void CNode::PushAddress	(	const CAddress &	_addr,
		FastRandomContext &	insecure_rand
	)

inline

Definition at line 941 of file net.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PushBlockHash()

void CNode::PushBlockHash ( const uint256 & hash )

inline

Definition at line 978 of file net.h.

◆ PushInventory()

void CNode::PushInventory ( const CInv & inv )

inline

Definition at line 965 of file net.h.

Here is the caller graph for this function:

◆ ReceiveMsgBytes()

bool CNode::ReceiveMsgBytes	(	const char *	pch,
		unsigned int	nBytes,
		bool &	complete
	)

Definition at line 568 of file net.cpp.

Here is the call graph for this function:

◆ Release()

void CNode::Release ( )

inline

Definition at line 928 of file net.h.

◆ SetAddrLocal()

void CNode::SetAddrLocal ( const CService & addrLocalIn )

May not be called more than once.

Definition at line 490 of file net.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRecvVersion()

void CNode::SetRecvVersion ( int nVersionIn )

inline

Definition at line 907 of file net.h.

Here is the caller graph for this function:

◆ SetSendVersion()

void CNode::SetSendVersion ( int nVersionIn )

Definition at line 605 of file net.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ CConnman

friend class CConnman

friend

Definition at line 709 of file net.h.

Member Data Documentation

◆ addr

const CAddress CNode::addr

Definition at line 739 of file net.h.

◆ addrBind

const CAddress CNode::addrBind

Definition at line 741 of file net.h.

◆ cs_addrLocal

RecursiveMutex CNode::cs_addrLocal

mutableprivate

Definition at line 884 of file net.h.

◆ cs_addrName

RecursiveMutex CNode::cs_addrName

mutableprivate

Definition at line 879 of file net.h.

◆ cs_hSocket

RecursiveMutex CNode::cs_hSocket

Definition at line 721 of file net.h.

◆ cs_inventory

RecursiveMutex CNode::cs_inventory

Definition at line 794 of file net.h.

◆ cs_sendProcessing

RecursiveMutex CNode::cs_sendProcessing

Definition at line 728 of file net.h.

◆ cs_SubVer

RecursiveMutex CNode::cs_SubVer

Definition at line 743 of file net.h.

◆ cs_vProcessMsg

RecursiveMutex CNode::cs_vProcessMsg

Definition at line 724 of file net.h.

◆ cs_vRecv

RecursiveMutex CNode::cs_vRecv

Definition at line 722 of file net.h.

◆ cs_vSend

RecursiveMutex CNode::cs_vSend

Definition at line 720 of file net.h.

◆ fClient

bool CNode::fClient {false}

Definition at line 758 of file net.h.

◆ fDisconnect

std::atomic_bool CNode::fDisconnect {false}

Definition at line 764 of file net.h.

◆ fFeeler

bool CNode::fFeeler {false}

Definition at line 755 of file net.h.

◆ fGetAddr

bool CNode::fGetAddr {false}

Definition at line 784 of file net.h.

◆ fInbound

const bool CNode::fInbound

Definition at line 760 of file net.h.

◆ fOneShot

bool CNode::fOneShot {false}

Definition at line 756 of file net.h.

◆ fPauseRecv

std::atomic_bool CNode::fPauseRecv {false}

Definition at line 770 of file net.h.

◆ fPauseSend

std::atomic_bool CNode::fPauseSend {false}

Definition at line 771 of file net.h.

◆ fPingQueued

std::atomic<bool> CNode::fPingQueued {false}

Definition at line 844 of file net.h.

◆ fSentAddr

bool CNode::fSentAddr {false}

Definition at line 765 of file net.h.

◆ fSuccessfullyConnected

std::atomic_bool CNode::fSuccessfullyConnected {false}

Definition at line 761 of file net.h.

◆ grantOutbound

CSemaphoreGrant CNode::grantOutbound

Definition at line 766 of file net.h.

◆ hashContinue

uint256 CNode::hashContinue

Definition at line 778 of file net.h.

◆ id

const NodeId CNode::id

private

Definition at line 854 of file net.h.

◆ m_addr_known

const std::unique_ptr<CRollingBloomFilter> CNode::m_addr_known

Definition at line 783 of file net.h.

◆ m_deserializer

std::unique_ptr<TransportDeserializer> CNode::m_deserializer

Definition at line 711 of file net.h.

◆ m_legacyWhitelisted

bool CNode::m_legacyWhitelisted {false}

Definition at line 754 of file net.h.

◆ m_limited_node

bool CNode::m_limited_node {false}

Definition at line 759 of file net.h.

◆ m_manual_connection

bool CNode::m_manual_connection {false}

Definition at line 757 of file net.h.

◆ m_permissionFlags

NetPermissionFlags CNode::m_permissionFlags { PF_NONE }

private

Definition at line 876 of file net.h.

◆ m_prefer_evict

bool CNode::m_prefer_evict {false}

Definition at line 749 of file net.h.

◆ m_tx_relay

std::unique_ptr<TxRelay> CNode::m_tx_relay

Definition at line 825 of file net.h.

◆ mapSendBytesPerMsgCmd

mapMsgCmdSize CNode::mapSendBytesPerMsgCmd

protected

Definition at line 774 of file net.h.

◆ nKeyedNetGroup

const uint64_t CNode::nKeyedNetGroup

Definition at line 769 of file net.h.

◆ nLastBlockTime

std::atomic<int64_t> CNode::nLastBlockTime {0}

Definition at line 831 of file net.h.

◆ nLastRecv

std::atomic<int64_t> CNode::nLastRecv {0}

Definition at line 735 of file net.h.

◆ nLastSend

std::atomic<int64_t> CNode::nLastSend {0}

Definition at line 734 of file net.h.

◆ nLastTXTime

std::atomic<int64_t> CNode::nLastTXTime {0}

Definition at line 832 of file net.h.

◆ nLocalHostNonce

const uint64_t CNode::nLocalHostNonce

private

Definition at line 855 of file net.h.

◆ nLocalServices

const ServiceFlags CNode::nLocalServices

private

Services offered to this peer.

This is supplied by the parent CConnman during peer connection (CConnman::ConnectNode()) from its attribute of the same name.

This is const because there is no protocol defined for renegotiating services initially offered to a peer. The set of local services we offer should not change after initialization.

An interesting example of this is NODE_NETWORK and initial block download: a node which starts up from scratch doesn't have any blocks to serve, but still advertises NODE_NETWORK because it will eventually fulfill this role after IBD completes. P2P code is written in such a way that it can gracefully handle peers who don't make good on their service advertisements.

Definition at line 872 of file net.h.

◆ nMinPingUsecTime

std::atomic<int64_t> CNode::nMinPingUsecTime {std::numeric_limits<int64_t>::max()}

Definition at line 842 of file net.h.

◆ nMyStartingHeight

const int CNode::nMyStartingHeight

private

Definition at line 874 of file net.h.

◆ nPingNonceSent

std::atomic<uint64_t> CNode::nPingNonceSent {0}

Definition at line 836 of file net.h.

◆ nPingUsecStart

std::atomic<int64_t> CNode::nPingUsecStart {0}

Definition at line 838 of file net.h.

◆ nPingUsecTime

std::atomic<int64_t> CNode::nPingUsecTime {0}

Definition at line 840 of file net.h.

◆ nProcessQueueSize

size_t CNode::nProcessQueueSize {0}

Definition at line 726 of file net.h.

◆ nRecvVersion

std::atomic<int> CNode::nRecvVersion {INIT_PROTO_VERSION}

Definition at line 732 of file net.h.

◆ nRefCount

std::atomic<int> CNode::nRefCount {0}

Definition at line 767 of file net.h.

◆ nSendOffset

size_t CNode::nSendOffset {0}

Definition at line 717 of file net.h.

◆ nSendSize

size_t CNode::nSendSize {0}

Definition at line 716 of file net.h.

◆ nSendVersion

int CNode::nSendVersion {0}

private

Definition at line 875 of file net.h.

◆ nServices

std::atomic<ServiceFlags> CNode::nServices {NODE_NONE}

Definition at line 714 of file net.h.

◆ nStartingHeight

std::atomic<int> CNode::nStartingHeight {-1}

Definition at line 779 of file net.h.

◆ nTimeConnected

const int64_t CNode::nTimeConnected

Definition at line 736 of file net.h.

◆ nTimeOffset

std::atomic<int64_t> CNode::nTimeOffset {0}

Definition at line 737 of file net.h.

◆ nVersion

std::atomic<int> CNode::nVersion {0}

Definition at line 742 of file net.h.

◆ orphan_work_set

std::set<uint256> CNode::orphan_work_set

Definition at line 846 of file net.h.

◆ vAddrToSend

std::vector<CAddress> CNode::vAddrToSend

Definition at line 782 of file net.h.

◆ vRecvGetData

std::deque<CInv> CNode::vRecvGetData

Definition at line 730 of file net.h.

◆ vRecvMsg

std::list<CNetMessage> CNode::vRecvMsg

private

Definition at line 877 of file net.h.

The documentation for this class was generated from the following files:

src/net.h
src/net.cpp

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CNode() [1/2]

◆ ~CNode()

◆ CNode() [2/2]

Member Function Documentation

◆ AddAddressKnown()

◆ AddInventoryKnown()

◆ AddRef()

◆ CloseSocketDisconnect()

◆ copyStats()

◆ GetAddrLocal()

◆ GetAddrName()

◆ GetId()

◆ GetLocalNonce()

◆ GetLocalServices()

◆ GetMyStartingHeight()

◆ GetRecvVersion()

◆ GetRefCount()

◆ GetSendVersion()

◆ GUARDED_BY() [1/13]

◆ GUARDED_BY() [2/13]

◆ GUARDED_BY() [3/13]

◆ GUARDED_BY() [4/13]

◆ GUARDED_BY() [5/13]

◆ GUARDED_BY() [6/13]

◆ GUARDED_BY() [7/13]

◆ GUARDED_BY() [8/13]

◆ GUARDED_BY() [9/13]

◆ GUARDED_BY() [10/13]

◆ GUARDED_BY() [11/13]

◆ GUARDED_BY() [12/13]

◆ GUARDED_BY() [13/13]

◆ HasPermission()

◆ IsAddrRelayPeer()

◆ MaybeSetAddrName()

◆ operator=()

◆ PushAddress()

◆ PushBlockHash()

◆ PushInventory()

◆ ReceiveMsgBytes()

◆ Release()

◆ SetAddrLocal()

◆ SetRecvVersion()

◆ SetSendVersion()

Friends And Related Function Documentation

◆ CConnman

Member Data Documentation

◆ addr

◆ addrBind

◆ cs_addrLocal

◆ cs_addrName

◆ cs_hSocket

◆ cs_inventory

◆ cs_sendProcessing

◆ cs_SubVer

◆ cs_vProcessMsg

◆ cs_vRecv

◆ cs_vSend

◆ fClient

◆ fDisconnect

◆ fFeeler

◆ fGetAddr

◆ fInbound

◆ fOneShot

◆ fPauseRecv

◆ fPauseSend

◆ fPingQueued

◆ fSentAddr

◆ fSuccessfullyConnected

◆ grantOutbound

◆ hashContinue