The underlying protocol and address used by a Face. More...

#include <ndn-cxx/net/face-uri.hpp>

Classes
class	Error

Public Types
typedef function< void(const std::string &reason)>	CanonizeFailureCallback

typedef function< void(const FaceUri &)>	CanonizeSuccessCallback

Public Member Functions
	FaceUri ()

	FaceUri (const boost::asio::ip::tcp::endpoint &endpoint)
	Construct a tcp4 or tcp6 canonical FaceUri. More...

	FaceUri (const boost::asio::ip::tcp::endpoint &endpoint, const std::string &scheme)
	Construct a tcp canonical FaceUri with custom scheme. More...

	FaceUri (const boost::asio::ip::udp::endpoint &endpoint)
	Construct a udp4 or udp6 canonical FaceUri. More...

	FaceUri (const char *uri)

	FaceUri (const ethernet::Address &address)
	Construct an ether canonical FaceUri. More...

	FaceUri (const std::string &uri)
	Construct by parsing. More...

void	canonize (const CanonizeSuccessCallback &onSuccess, const CanonizeFailureCallback &onFailure, boost::asio::io_service &io, time::nanoseconds timeout) const
	Asynchronously convert this FaceUri to canonical form. More...

const std::string &	getHost () const
	Get host (domain) More...

const std::string &	getPath () const
	Get path. More...

const std::string &	getPort () const
	Get port. More...

const std::string &	getScheme () const
	Get scheme (protocol) More...

bool	isCanonical () const
	Determine whether this FaceUri is in canonical form. More...

bool	parse (const std::string &uri)
	Exception-safe parsing. More...

std::string	toString () const
	Serialize as a string. More...

Static Public Member Functions
static bool	canCanonize (const std::string &scheme)
	Return whether a FaceUri of the specified scheme can be canonized. More...

static FaceUri	fromDev (const std::string &ifname)
	Construct a dev FaceUri from a network device name. More...

static FaceUri	fromFd (int fd)
	Construct an fd FaceUri from a file descriptor. More...

static FaceUri	fromUdpDev (const boost::asio::ip::udp::endpoint &endpoint, const std::string &ifname)
	Construct a udp4 or udp6 NIC-associated FaceUri from endpoint and network device name. More...

Friends
bool	operator!= (const FaceUri &lhs, const FaceUri &rhs)

std::ostream &	operator<< (std::ostream &os, const FaceUri &uri)

bool	operator== (const FaceUri &lhs, const FaceUri &rhs)

Detailed Description

The underlying protocol and address used by a Face.

See also: https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#FaceUri

Definition at line 45 of file face-uri.hpp.

Member Typedef Documentation

◆ CanonizeFailureCallback

typedef function<void(const std::string& reason)> ndn::FaceUri::CanonizeFailureCallback

Definition at line 156 of file face-uri.hpp.

◆ CanonizeSuccessCallback

typedef function<void(const FaceUri&)> ndn::FaceUri::CanonizeSuccessCallback

Definition at line 155 of file face-uri.hpp.

Constructor & Destructor Documentation

◆ FaceUri() [1/7]

ndn::FaceUri::FaceUri ( )

Definition at line 46 of file face-uri.cpp.

◆ FaceUri() [2/7]

ndn::FaceUri::FaceUri ( const std::string & uri )

explicit

Construct by parsing.

Parameters

uri	scheme://host[:port]/path

Exceptions

FaceUri::Error if URI cannot be parsed

Definition at line 51 of file face-uri.cpp.

◆ FaceUri() [3/7]

ndn::FaceUri::FaceUri ( const char * uri )

explicit

Definition at line 58 of file face-uri.cpp.

◆ FaceUri() [4/7]

ndn::FaceUri::FaceUri ( const boost::asio::ip::udp::endpoint & endpoint )

explicit

Construct a udp4 or udp6 canonical FaceUri.

Definition at line 120 of file face-uri.cpp.

◆ FaceUri() [5/7]

ndn::FaceUri::FaceUri ( const boost::asio::ip::tcp::endpoint & endpoint )

explicit

Construct a tcp4 or tcp6 canonical FaceUri.

Definition at line 128 of file face-uri.cpp.

◆ FaceUri() [6/7]

ndn::FaceUri::FaceUri	(	const boost::asio::ip::tcp::endpoint &	endpoint,
		const std::string &	scheme
	)

Construct a tcp canonical FaceUri with custom scheme.

Definition at line 136 of file face-uri.cpp.

◆ FaceUri() [7/7]

ndn::FaceUri::FaceUri ( const ethernet::Address & address )

explicit

Construct an ether canonical FaceUri.

Definition at line 162 of file face-uri.cpp.

Member Function Documentation

◆ canCanonize()

bool ndn::FaceUri::canCanonize ( const std::string & scheme )

static

Return whether a FaceUri of the specified scheme can be canonized.

Definition at line 613 of file face-uri.cpp.

◆ canonize()

void ndn::FaceUri::canonize	(	const CanonizeSuccessCallback &	onSuccess,
		const CanonizeFailureCallback &	onFailure,
		boost::asio::io_service &	io,
		time::nanoseconds	timeout
	)		const

Asynchronously convert this FaceUri to canonical form.

Parameters

onSuccess function to call after this FaceUri is converted to canonical form

Note: A new FaceUri in canonical form will be created; this FaceUri is unchanged.

Parameters

onFailure	function to call if this FaceUri cannot be converted to canonical form
io	reference to `boost::asio::io_service` instance
timeout	maximum allowable duration of the operations. It's intentional not to provide a default value: the caller should set a reasonable value in balance between network delay and user experience.

Definition at line 630 of file face-uri.cpp.

◆ fromDev()

FaceUri ndn::FaceUri::fromDev ( const std::string & ifname )

static

Construct a dev FaceUri from a network device name.

Definition at line 170 of file face-uri.cpp.

◆ fromFd()

FaceUri ndn::FaceUri::fromFd ( int fd )

static

Construct an fd FaceUri from a file descriptor.

Definition at line 154 of file face-uri.cpp.

◆ fromUdpDev()

FaceUri ndn::FaceUri::fromUdpDev	(	const boost::asio::ip::udp::endpoint &	endpoint,
		const std::string &	ifname
	)

static

Construct a udp4 or udp6 NIC-associated FaceUri from endpoint and network device name.

Definition at line 179 of file face-uri.cpp.

◆ getHost()

const std::string& ndn::FaceUri::getHost ( ) const

inline

Get host (domain)

Definition at line 117 of file face-uri.hpp.

◆ getPath()

const std::string& ndn::FaceUri::getPath ( ) const

inline

Get path.

Definition at line 131 of file face-uri.hpp.

◆ getPort()

const std::string& ndn::FaceUri::getPort ( ) const

inline

Get port.

Definition at line 124 of file face-uri.hpp.

◆ getScheme()

const std::string& ndn::FaceUri::getScheme ( ) const

inline

Get scheme (protocol)

Definition at line 110 of file face-uri.hpp.

◆ isCanonical()

bool ndn::FaceUri::isCanonical ( ) const

Determine whether this FaceUri is in canonical form.

Returns: true if this FaceUri is in canonical form, false if this FaceUri is not in canonical form or or it's undetermined whether this FaceUri is in canonical form

Definition at line 619 of file face-uri.cpp.

◆ parse()

bool ndn::FaceUri::parse ( const std::string & uri )

Exception-safe parsing.

Definition at line 64 of file face-uri.cpp.

◆ toString()

std::string ndn::FaceUri::toString ( ) const

Serialize as a string.

Definition at line 189 of file face-uri.cpp.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const FaceUri &	lhs,
		const FaceUri &	rhs
	)

friend

Definition at line 184 of file face-uri.hpp.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const FaceUri &	uri
	)

friend

Definition at line 196 of file face-uri.cpp.

◆ operator==

bool operator==	(	const FaceUri &	lhs,
		const FaceUri &	rhs
	)

friend

Definition at line 178 of file face-uri.hpp.

ndn-cxx: NDN C++ library with eXperimental eXtensions 0.8.1 documentation

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ CanonizeFailureCallback

◆ CanonizeSuccessCallback

Constructor & Destructor Documentation

◆ FaceUri() [1/7]

◆ FaceUri() [2/7]

◆ FaceUri() [3/7]

◆ FaceUri() [4/7]

◆ FaceUri() [5/7]

◆ FaceUri() [6/7]

◆ FaceUri() [7/7]

Member Function Documentation

◆ canCanonize()

◆ canonize()

◆ fromDev()

◆ fromFd()

◆ fromUdpDev()

◆ getHost()

◆ getPath()

◆ getPort()

◆ getScheme()

◆ isCanonical()

◆ parse()

◆ toString()

Friends And Related Function Documentation

◆ operator!=

◆ operator<<

◆ operator==