#include <compat.h>
#include <netaddress.h>
#include <serialize.h>
#include <stdint.h>
#include <string>
#include <vector>

Include dependency graph for netbase.h:

This graph shows which files directly or indirectly include this file:

Classes
class	proxyType

Functions
enum Network	ParseNetwork (const std::string &net)

std::string	GetNetworkName (enum Network net)

bool	SetProxy (enum Network net, const proxyType &addrProxy)

bool	GetProxy (enum Network net, proxyType &proxyInfoOut)

bool	IsProxy (const CNetAddr &addr)

bool	SetNameProxy (const proxyType &addrProxy)
	Set the name proxy to use for all connections to nodes specified by a hostname. More...

bool	HaveNameProxy ()

bool	GetNameProxy (proxyType &nameProxyOut)

bool	LookupHost (const std::string &name, std::vector< CNetAddr > &vIP, unsigned int nMaxSolutions, bool fAllowLookup)
	Resolve a host string to its corresponding network addresses. More...

bool	LookupHost (const std::string &name, CNetAddr &addr, bool fAllowLookup)
	Resolve a host string to its first corresponding network address. More...

bool	Lookup (const std::string &name, CService &addr, int portDefault, bool fAllowLookup)
	Resolve a service string to its first corresponding service. More...

bool	Lookup (const std::string &name, std::vector< CService > &vAddr, int portDefault, bool fAllowLookup, unsigned int nMaxSolutions)
	Resolve a service string to its corresponding service. More...

CService	LookupNumeric (const std::string &name, int portDefault=0)
	Resolve a service string with a numeric IP to its first corresponding service. More...

bool	LookupSubNet (const std::string &strSubnet, CSubNet &subnet)
	Parse and resolve a specified subnet string into the appropriate internal representation. More...

SOCKET	CreateSocket (const CService &addrConnect)
	Try to create a socket file descriptor with specific properties in the communications domain (address family) of the specified service. More...

bool	ConnectSocketDirectly (const CService &addrConnect, const SOCKET &hSocketRet, int nTimeout, bool manual_connection)
	Try to connect to the specified service on the specified socket. More...

bool	ConnectThroughProxy (const proxyType &proxy, const std::string &strDest, int port, const SOCKET &hSocketRet, int nTimeout, bool &outProxyConnectionFailed)
	Connect to a specified destination service through a SOCKS5 proxy by first connecting to the SOCKS5 proxy. More...

std::string	NetworkErrorString (int err)
	Return readable error string for a network error code. More...

bool	CloseSocket (SOCKET &hSocket)
	Close socket and set hSocket to INVALID_SOCKET. More...

bool	SetSocketNonBlocking (const SOCKET &hSocket, bool fNonBlocking)
	Disable or enable blocking-mode for a socket. More...

bool	SetSocketNoDelay (const SOCKET &hSocket)
	Set the TCP_NODELAY flag on a socket. More...

struct timeval	MillisToTimeval (int64_t nTimeout)
	Convert milliseconds to a struct timeval for e.g. More...

void	InterruptSocks5 (bool interrupt)

Variables
int	nConnectTimeout

bool	fNameLookup

static const int	DEFAULT_CONNECT_TIMEOUT = 5000
	-timeout default More...

static const int	DEFAULT_NAME_LOOKUP = true
	-dns default More...

Function Documentation

bool CloseSocket ( SOCKET & hSocket )

Close socket and set hSocket to INVALID_SOCKET.

Definition at line 907 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool ConnectSocketDirectly	(	const CService &	addrConnect,
		const SOCKET &	hSocket,
		int	nTimeout,
		bool	manual_connection
	)

Try to connect to the specified service on the specified socket.

Parameters

addrConnect	The service to which to connect.
hSocket	The socket on which to connect.
nTimeout	Wait this many milliseconds for the connection to be established.
manual_connection	Whether or not the connection was manually requested (e.g. through the addnode RPC)

Returns: Whether or not a connection was successfully made.

Definition at line 638 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool ConnectThroughProxy	(	const proxyType &	proxy,
		const std::string &	strDest,
		int	port,
		const SOCKET &	hSocket,
		int	nTimeout,
		bool &	outProxyConnectionFailed
	)

Connect to a specified destination service through a SOCKS5 proxy by first connecting to the SOCKS5 proxy.

Parameters

	proxy	The SOCKS5 proxy.
	strDest	The destination service to which to connect.
	port	The destination port.
	hSocket	The socket on which to connect to the SOCKS5 proxy.
	nTimeout	Wait this many milliseconds for the connection to the SOCKS5 proxy to be established.
[out]	outProxyConnectionFailed	Whether or not the connection to the SOCKS5 proxy failed.

Returns: Whether or not the operation succeeded.

Definition at line 797 of file netbase.cpp.

Here is the call graph for this function:

SOCKET CreateSocket ( const CService & addrConnect )

Try to create a socket file descriptor with specific properties in the communications domain (address family) of the specified service.

For details on the desired properties, see the inline comments in the source code.

Definition at line 575 of file netbase.cpp.

Here is the call graph for this function:

bool GetNameProxy ( proxyType & nameProxyOut )

Definition at line 760 of file netbase.cpp.

std::string GetNetworkName ( enum Network net )

Definition at line 55 of file netbase.cpp.

Here is the caller graph for this function:

bool GetProxy	(	enum Network	net,
		proxyType &	proxyInfoOut
	)

Definition at line 727 of file netbase.cpp.

Here is the caller graph for this function:

bool HaveNameProxy ( )

Definition at line 768 of file netbase.cpp.

void InterruptSocks5 ( bool interrupt )

Definition at line 957 of file netbase.cpp.

Here is the call graph for this function:

bool IsProxy ( const CNetAddr & addr )

Definition at line 773 of file netbase.cpp.

bool Lookup	(	const std::string &	name,
		CService &	addr,
		int	portDefault,
		bool	fAllowLookup
	)

Resolve a service string to its first corresponding service.

See also: Lookup(const char *, std::vector<CService>&, int, bool, unsigned int) for additional parameter descriptions.

Definition at line 238 of file netbase.cpp.

Here is the call graph for this function:

bool Lookup	(	const std::string &	name,
		std::vector< CService > &	vAddr,
		int	portDefault,
		bool	fAllowLookup,
		unsigned int	nMaxSolutions
	)

Resolve a service string to its corresponding service.

Parameters

	name	The string representing a service. Could be a name or a numerical IP address (IPv6 addresses should be in their disambiguated bracketed form), optionally followed by a port number. (e.g. example.com:8333 or
[out]	vAddr	The resulting services to which the specified service string resolved.
	portDefault	The default port for resulting services if not specified by the service string.
	fAllowLookup	Whether or not hostname lookups are permitted. If yes, external queries may be performed.
	nMaxSolutions	The maximum number of results we want, specifying 0 means "as many solutions as we get."

Returns: Whether or not the service string successfully resolved to any resulting services.

Definition at line 213 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool LookupHost	(	const std::string &	name,
		std::vector< CNetAddr > &	vIP,
		unsigned int	nMaxSolutions,
		bool	fAllowLookup
	)

Resolve a host string to its corresponding network addresses.

Parameters

	name	The string representing a host. Could be a name or a numerical IP address (IPv6 addresses in their bracketed form are allowed).
[out]	vIP	The resulting network addresses to which the specified host string resolved.

Returns: Whether or not the specified host string successfully resolved to any resulting network addresses.

See also: Lookup(const char *, std::vector<CService>&, int, bool, unsigned int) for additional parameter descriptions.

Definition at line 159 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool LookupHost	(	const std::string &	name,
		CNetAddr &	addr,
		bool	fAllowLookup
	)

Resolve a host string to its first corresponding network address.

See also: LookupHost(const std::string&, std::vector<CNetAddr>&, unsigned int, bool) for additional parameter descriptions.

Definition at line 180 of file netbase.cpp.

Here is the call graph for this function:

CService LookupNumeric	(	const std::string &	name,
		int	portDefault
	)

Resolve a service string with a numeric IP to its first corresponding service.

Returns: The resulting CService if the resolution was successful, [::]:0 otherwise.

See also: Lookup(const char *, CService&, int, bool) for additional parameter descriptions.

Definition at line 261 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool LookupSubNet	(	const std::string &	strSubnet,
		CSubNet &	ret
	)

Parse and resolve a specified subnet string into the appropriate internal representation.

Parameters

strSubnet	A string representation of a subnet of the form `network address [ "/", ( CIDR-style suffix \| netmask ) ]`(e.g. `2001:db8::/32`, `192.0.2.0/255.255.255.0`, or `8.8.8.8`).
ret	The resulting internal representation of a subnet.

Returns: Whether the operation succeeded or not.

Definition at line 831 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

struct timeval MillisToTimeval ( int64_t nTimeout )

Convert milliseconds to a struct timeval for e.g.

select.

Definition at line 274 of file netbase.cpp.

Here is the caller graph for this function:

std::string NetworkErrorString ( int err )

Return readable error string for a network error code.

Definition at line 889 of file netbase.cpp.

Here is the caller graph for this function:

enum Network ParseNetwork ( const std::string & net )

Definition at line 43 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool SetNameProxy ( const proxyType & addrProxy )

Set the name proxy to use for all connections to nodes specified by a hostname.

After setting this proxy, connecting to a node specified by a hostname won't result in a local lookup of said hostname, rather, connect to the node by asking the name proxy for a proxy connection to the hostname, effectively delegating the hostname lookup to the specified proxy.

This delegation increases privacy for those who set the name proxy as they no longer leak their external hostname queries to their DNS servers.

Returns: Whether or not the operation succeeded.

Note: SOCKS5's support for UDP-over-SOCKS5 has been considered, but no SOCK5 server in common use (most notably Tor) actually implements UDP support, and a DNS resolver is beyond the scope of this project.

Definition at line 752 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool SetProxy	(	enum Network	net,
		const proxyType &	addrProxy
	)

Definition at line 718 of file netbase.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool SetSocketNoDelay ( const SOCKET & hSocket )

Set the TCP_NODELAY flag on a socket.

Definition at line 950 of file netbase.cpp.

Here is the caller graph for this function:

bool SetSocketNonBlocking	(	const SOCKET &	hSocket,
		bool	fNonBlocking
	)

Disable or enable blocking-mode for a socket.

Definition at line 923 of file netbase.cpp.

Here is the caller graph for this function:

Variable Documentation

const int DEFAULT_CONNECT_TIMEOUT = 5000

static

-timeout default

Definition at line 24 of file netbase.h.

const int DEFAULT_NAME_LOOKUP = true

static

-dns default

Definition at line 26 of file netbase.h.

bool fNameLookup

Definition at line 37 of file netbase.cpp.

int nConnectTimeout

Definition at line 36 of file netbase.cpp.

Classes

Functions

Variables

Function Documentation

Variable Documentation