net::tor_address Class Reference

Tor onion address; internal format not condensed/decoded. More...

#include <tor_address.h>

Public Member Functions
	tor_address () noexcept
	An object with port() == 0 and host_str() == unknown_str(). More...
bool	_load (epee::serialization::portable_storage &src, epee::serialization::section *hparent)
	Load from epee p2p format, and. More...
bool	store (epee::serialization::portable_storage &dest, epee::serialization::section *hparent) const
	Store in epee p2p format. More...
	tor_address (const tor_address &rhs) noexcept
	~tor_address ()=default
tor_address &	operator= (const tor_address &rhs) noexcept
bool	is_unknown () const noexcept
bool	equal (const tor_address &rhs) const noexcept
bool	less (const tor_address &rhs) const noexcept
bool	is_same_host (const tor_address &rhs) const noexcept
std::string	str () const
const char *	host_str () const noexcept
std::uint16_t	port () const noexcept
bool	is_blockable () const noexcept

Static Public Member Functions
static constexpr std::size_t	buffer_size () noexcept
static const char *	unknown_str () noexcept
static tor_address	unknown () noexcept
static expect< tor_address >	make (boost::string_ref address, std::uint16_t default_port=0)
static constexpr bool	is_loopback () noexcept
static constexpr bool	is_local () noexcept
static constexpr epee::net_utils::address_type	get_type_id () noexcept
static constexpr epee::net_utils::zone	get_zone () noexcept

Private Member Functions
	tor_address (boost::string_ref host, std::uint16_t port) noexcept
	Keep in private, host.size() has no runtime check. More...

Private Attributes
std::uint16_t	port_
char	host_ [63]

Detailed Description

Tor onion address; internal format not condensed/decoded.

Constructor & Destructor Documentation

tor_address() [1/3]

net::tor_address::tor_address ( boost::string_ref  host, std::uint16_t  port  )

privatenoexcept

Keep in private, host.size() has no runtime check.

tor_address() [2/3]

net::tor_address::tor_address ( )

noexcept

An object with port() == 0 and host_str() == unknown_str().

tor_address() [3/3]

net::tor_address::tor_address ( const tor_address &  rhs )

noexcept

~tor_address()

net::tor_address::~tor_address ( )

default

Member Function Documentation

_load()

bool net::tor_address::_load	(	epee::serialization::portable_storage &	src,
		epee::serialization::section *	hparent
	)

Load from epee p2p format, and.

Returns

false if not valid tor address

buffer_size()

static constexpr std::size_t net::tor_address::buffer_size ( )

inlinestaticconstexprnoexcept

Returns

Size of internal buffer for host.

equal()

bool net::tor_address::equal ( const tor_address &  rhs ) const

noexcept

get_type_id()

static constexpr epee::net_utils::address_type net::tor_address::get_type_id ( )

inlinestaticconstexprnoexcept

get_zone()

static constexpr epee::net_utils::zone net::tor_address::get_zone ( )

inlinestaticconstexprnoexcept

host_str()

const char* net::tor_address::host_str ( ) const

inlinenoexcept

Returns

Null-terminated x.onion value or unknown_str().

is_blockable()

bool net::tor_address::is_blockable ( ) const

inlinenoexcept

Returns

!is_unknown().

is_local()

static constexpr bool net::tor_address::is_local ( )

inlinestaticconstexprnoexcept

is_loopback()

static constexpr bool net::tor_address::is_loopback ( )

inlinestaticconstexprnoexcept

is_same_host()

bool net::tor_address::is_same_host ( const tor_address &  rhs ) const

noexcept

Returns

True if onion addresses are identical.

\TODO v2 and v3 should be comparable - requires base32

is_unknown()

bool net::tor_address::is_unknown ( ) const

noexcept

Returns

True if default constructed or via unknown().

less()

bool net::tor_address::less ( const tor_address &  rhs ) const

noexcept

make()

expect< tor_address > net::tor_address::make ( boost::string_ref  address, std::uint16_t  default_port = 0  )

static

Parse address in onion v2 or v3 format with (i.e. x.onion:80) with default_port being used iff port is not specified in address.

operator=()

tor_address & net::tor_address::operator= ( const tor_address &  rhs )

noexcept

port()

std::uint16_t net::tor_address::port ( ) const

inlinenoexcept

Returns

Port value or 0 if unspecified.

store()

bool net::tor_address::store	(	epee::serialization::portable_storage &	dest,
		epee::serialization::section *	hparent
	)		const

Store in epee p2p format.

str()

std::string net::tor_address::str

(

)

const

Returns

x.onion or x.onion:z if port() != 0.

unknown()

static tor_address net::tor_address::unknown ( )

inlinestaticnoexcept

Returns

A default constructed tor_address object.

unknown_str()

const char * net::tor_address::unknown_str ( )

staticnoexcept

Returns

<unknown tor host>.

Member Data Documentation

host_

char net::tor_address::host_[63]

private

port_

std::uint16_t net::tor_address::port_

private

---

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

• src/net/tor_address.h
• src/net/tor_address.cpp