protocol.h File Reference

#include <netaddress.h>
#include <serialize.h>
#include <uint256.h>
#include <version.h>
#include <atomic>
#include <stdint.h>
#include <string>

Go to the source code of this file.

Classes
class	CMessageHeader
class	CAddress
class	CInv

Namespaces
	NetMsgType

Enumerations
enum	ServiceFlags : uint64_t {   NODE_NONE = 0, NODE_NETWORK = (1 << 0), NODE_GETUTXO = (1 << 1), NODE_BLOOM = (1 << 2),   NODE_WITNESS = (1 << 3), NODE_NETWORK_LIMITED = (1 << 10) }
enum	GetDataMsg {   UNDEFINED = 0, MSG_TX = 1, MSG_BLOCK = 2, MSG_FILTERED_BLOCK = 3,   MSG_CMPCT_BLOCK = 4, MSG_WITNESS_BLOCK = MSG_BLOCK | MSG_WITNESS_FLAG, MSG_WITNESS_TX = MSG_TX | MSG_WITNESS_FLAG, MSG_FILTERED_WITNESS_BLOCK = MSG_FILTERED_BLOCK | MSG_WITNESS_FLAG }

Functions
const std::vector< std::string > &	getAllNetMessageTypes ()
ServiceFlags	GetDesirableServiceFlags (ServiceFlags services)
void	SetServiceFlagsIBDCache (bool status)
static bool	HasAllDesirableServiceFlags (ServiceFlags services)
static bool	MayHaveUsefulAddressDB (ServiceFlags services)

Variables
const uint32_t	MSG_WITNESS_FLAG = 1 << 30
const uint32_t	MSG_TYPE_MASK = 0xffffffff >> 2

Enumeration Type Documentation

GetDataMsg

enum GetDataMsg

getdata / inv message types. These numbers are defined by the protocol. When adding a new value, be sure to mention it in the respective BIP.

Enumerator
UNDEFINED
MSG_TX
MSG_BLOCK
MSG_FILTERED_BLOCK	Defined in BIP37.
MSG_CMPCT_BLOCK	Defined in BIP152.
MSG_WITNESS_BLOCK	Defined in BIP144.
MSG_WITNESS_TX	Defined in BIP144.
MSG_FILTERED_WITNESS_BLOCK

ServiceFlags

enum ServiceFlags : uint64_t

nServices flags

Enumerator
NODE_NONE
NODE_NETWORK
NODE_GETUTXO
NODE_BLOOM
NODE_WITNESS
NODE_NETWORK_LIMITED

Function Documentation

getAllNetMessageTypes()

const std::vector<std::string>& getAllNetMessageTypes

(

)

GetDesirableServiceFlags()

ServiceFlags GetDesirableServiceFlags

(

ServiceFlags

services

)

Gets the set of service flags which are "desirable" for a given peer.

These are the flags which are required for a peer to support for them to be "interesting" to us, ie for us to wish to use one of our few outbound connection slots for or for us to wish to prioritize keeping their connection around.

Relevant service flags may be peer- and state-specific in that the version of the peer may determine which flags are required (eg in the case of NODE_NETWORK_LIMITED where we seek out NODE_NETWORK peers unless they set NODE_NETWORK_LIMITED and we are out of IBD, in which case NODE_NETWORK_LIMITED suffices).

Thus, generally, avoid calling with peerServices == NODE_NONE, unless state-specific flags must absolutely be avoided. When called with peerServices == NODE_NONE, the returned desirable service flags are guaranteed to not change dependent on state - ie they are suitable for use when describing peers which we know to be desirable, but for which we do not have a confirmed set of service flags.

If the NODE_NONE return value is changed, contrib/seeds/makeseeds.py should be updated appropriately to filter for the same nodes.

HasAllDesirableServiceFlags()

static bool HasAllDesirableServiceFlags ( ServiceFlags  services )

inlinestatic

A shortcut for (services & GetDesirableServiceFlags(services)) == GetDesirableServiceFlags(services), ie determines whether the given set of service flags are sufficient for a peer to be "relevant".

MayHaveUsefulAddressDB()

static bool MayHaveUsefulAddressDB ( ServiceFlags  services )

inlinestatic

Checks if a peer with the given service flags may be capable of having a robust address-storage DB.

SetServiceFlagsIBDCache()

void SetServiceFlagsIBDCache

(

bool

status

)

Set the current IBD status in order to figure out the desirable service flags

Variable Documentation

MSG_TYPE_MASK

const uint32_t MSG_TYPE_MASK = 0xffffffff >> 2

MSG_WITNESS_FLAG

const uint32_t MSG_WITNESS_FLAG = 1 << 30

getdata message type flags