CService Class Reference

A combination of a network address (CNetAddr) and a (TCP) port. More...

#include <netaddress.h>

Inheritance diagram for CService:

Collaboration diagram for CService:

Public Member Functions
	CService ()
	CService (const CNetAddr &ip, uint16_t port)
	CService (const struct in_addr &ipv4Addr, uint16_t port)
	CService (const struct sockaddr_in &addr)
uint16_t	GetPort () const
bool	GetSockAddr (struct sockaddr *paddr, socklen_t *addrlen) const
	Obtain the IPv4/6 socket address this represents.
bool	SetSockAddr (const struct sockaddr *paddr)
std::vector< uint8_t >	GetKey () const
std::string	ToString () const
std::string	ToStringPort () const
std::string	ToStringIPPort () const
	CService (const struct in6_addr &ipv6Addr, uint16_t port)
	CService (const struct sockaddr_in6 &addr)
	SERIALIZE_METHODS (CService, obj)
Public Member Functions inherited from CNetAddr
	CNetAddr ()
	Construct an unspecified IPv6 network address (::/128).
	CNetAddr (const struct in_addr &ipv4Addr)
void	SetIP (const CNetAddr &ip)
void	SetLegacyIPv6 (Span< const uint8_t > ipv6)
	Set from a legacy IPv6 address.
bool	SetInternal (const std::string &name)
	Create an "internal" address that represents a name or FQDN.
bool	SetSpecial (const std::string &addr)
	Parse a Tor or I2P address and set this object to it.
bool	IsBindAny () const
bool	IsIPv4 () const
bool	IsIPv6 () const
bool	IsRFC1918 () const
bool	IsRFC2544 () const
bool	IsRFC6598 () const
bool	IsRFC5737 () const
bool	IsRFC3849 () const
bool	IsRFC3927 () const
bool	IsRFC3964 () const
bool	IsRFC4193 () const
bool	IsRFC4380 () const
bool	IsRFC4843 () const
bool	IsRFC7343 () const
bool	IsRFC4862 () const
bool	IsRFC6052 () const
bool	IsRFC6145 () const
bool	IsHeNet () const
bool	IsTor () const
	Check whether this object represents a TOR address.
bool	IsI2P () const
	Check whether this object represents an I2P address.
bool	IsCJDNS () const
	Check whether this object represents a CJDNS address.
bool	IsLocal () const
bool	IsRoutable () const
bool	IsInternal () const
bool	IsValid () const
bool	IsAddrV1Compatible () const
	Check if the current object can be serialized in pre-ADDRv2/BIP155 format.
enum Network	GetNetwork () const
std::string	ToString () const
std::string	ToStringIP () const
bool	GetInAddr (struct in_addr *pipv4Addr) const
	Try to get our IPv4 address.
Network	GetNetClass () const
uint32_t	GetLinkedIPv4 () const
	For IPv4, mapped IPv4, SIIT translated IPv4, Teredo, 6to4 tunneled addresses, return the relevant IPv4 address as a uint32.
bool	HasLinkedIPv4 () const
	Whether this address has a linked IPv4 address (see GetLinkedIPv4()).
uint32_t	GetMappedAS (const std::vector< bool > &asmap) const
std::vector< uint8_t >	GetGroup (const std::vector< bool > &asmap) const
	Get the canonical identifier of our network group.
std::vector< uint8_t >	GetAddrBytes () const
int	GetReachabilityFrom (const CNetAddr *paddrPartner=nullptr) const
	Calculates a metric for how reachable (*this) is from a given partner.
	CNetAddr (const struct in6_addr &pipv6Addr, const uint32_t scope=0)
bool	GetIn6Addr (struct in6_addr *pipv6Addr) const
	Try to get our IPv6 address.
bool	IsRelayable () const
	Whether this address should be relayed to other peers even if we can't reach it ourselves.
template<typename Stream >
void	Serialize (Stream &s) const
	Serialize to a stream.
template<typename Stream >
void	Unserialize (Stream &s)
	Unserialize from a stream.

Protected Attributes
uint16_t	port
Protected Attributes inherited from CNetAddr
prevector< ADDR_IPV6_SIZE, uint8_t >	m_addr {ADDR_IPV6_SIZE, 0x0}
	Raw representation of the network address.
Network	m_net {NET_IPV6}
	Network to which this address belongs.
uint32_t	m_scope_id {0}
	Scope id if scoped/link-local IPV6 address.

Friends
class	CServiceHash
bool	operator== (const CService &a, const CService &b)
bool	operator!= (const CService &a, const CService &b)
bool	operator< (const CService &a, const CService &b)

Detailed Description

A combination of a network address (CNetAddr) and a (TCP) port.

Definition at line 545 of file netaddress.h.

Constructor & Destructor Documentation

CService() [1/6]

CService::CService

(

)

Definition at line 971 of file netaddress.cpp.

Here is the caller graph for this function:

CService() [2/6]

CService::CService	(	const CNetAddr &	ip,
		uint16_t	port
	)

Definition at line 973 of file netaddress.cpp.

CService() [3/6]

CService::CService	(	const struct in_addr &	ipv4Addr,
		uint16_t	port
	)

Definition at line 976 of file netaddress.cpp.

CService() [4/6]

CService::CService ( const struct sockaddr_in &  addr )

explicit

Definition at line 982 of file netaddress.cpp.

Here is the call graph for this function:

CService() [5/6]

CService::CService	(	const struct in6_addr &	ipv6Addr,
		uint16_t	port
	)

Definition at line 979 of file netaddress.cpp.

CService() [6/6]

CService::CService ( const struct sockaddr_in6 &  addr )

explicit

Definition at line 987 of file netaddress.cpp.

Here is the call graph for this function:

Member Function Documentation

GetKey()

std::vector< uint8_t > CService::GetKey

(

)

const

Returns

An identifier unique to this service's address and port number.

Definition at line 1073 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetPort()

uint16_t CService::GetPort

(

)

const

Definition at line 1008 of file netaddress.cpp.

Here is the caller graph for this function:

GetSockAddr()

bool CService::GetSockAddr	(	struct sockaddr *	paddr,
		socklen_t *	addrlen
	)		const

Obtain the IPv4/6 socket address this represents.

Parameters

[out]	paddr	The obtained socket address.
[in,out]	addrlen	The size, in bytes, of the address structure pointed to by paddr. The value that's pointed to by this parameter might change after calling this function if the size of the corresponding address structure changed.

Returns

Whether or not the operation was successful.

Definition at line 1035 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SERIALIZE_METHODS()

CService::SERIALIZE_METHODS ( CService  , obj    )

inline

Definition at line 571 of file netaddress.h.

Here is the call graph for this function:

SetSockAddr()

bool CService::SetSockAddr

(

const struct sockaddr *

paddr

)

Definition at line 993 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ToString()

std::string CService::ToString

(

)

const

Definition at line 1094 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ToStringIPPort()

std::string CService::ToStringIPPort

(

)

const

Definition at line 1086 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ToStringPort()

std::string CService::ToStringPort

(

)

const

Definition at line 1082 of file netaddress.cpp.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

CServiceHash

friend class CServiceHash

friend

Definition at line 576 of file netaddress.h.

operator!=

bool operator!= ( const CService &  a, const CService &  b  )

friend

Definition at line 559 of file netaddress.h.

operator<

bool operator< ( const CService &  a, const CService &  b  )

friend

Definition at line 1017 of file netaddress.cpp.

operator==

bool operator== ( const CService &  a, const CService &  b  )

friend

Definition at line 1012 of file netaddress.cpp.

Member Data Documentation

port

uint16_t CService::port

protected

Definition at line 548 of file netaddress.h.

---

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

• src/netaddress.h
• src/netaddress.cpp