#include <dht.h>

Inheritance diagram for dht::Dht:

Collaboration diagram for dht::Dht:

Public Member Functions
	Dht (std::unique_ptr< net::DatagramSocket > &&sock, const Config &config, const Sp< Logger > &l={})

	Dht (std::unique_ptr< net::DatagramSocket > &&sock, const Config &config, const Logger &l={})

const InfoHash &	getNodeId () const override

NodeStatus	updateStatus (sa_family_t af) override

NodeStatus	getStatus (sa_family_t af) const override

NodeStatus	getStatus () const override

net::DatagramSocket *	getSocket () const override

void	shutdown (ShutdownCallback cb, bool stop=false) override

bool	isRunning (sa_family_t af=0) const override

virtual void	registerType (const ValueType &type) override

const ValueType &	getType (ValueType::Id type_id) const override

void	addBootstrap (const std::string &host, const std::string &service) override

void	clearBootstrap () override

void	insertNode (const InfoHash &id, const SockAddr &) override

void	insertNode (const NodeExport &n) override

void	pingNode (SockAddr, DoneCallbackSimple &&cb={}) override

time_point	periodic (const uint8_t *buf, size_t buflen, SockAddr, const time_point &now) override

time_point	periodic (const uint8_t buf, size_t buflen, const sockaddr from, socklen_t fromlen, const time_point &now) override

virtual void	get (const InfoHash &key, GetCallback cb, DoneCallback donecb={}, Value::Filter &&f={}, Where &&w={}) override

virtual void	get (const InfoHash &key, GetCallback cb, DoneCallbackSimple donecb={}, Value::Filter &&f={}, Where &&w={}) override

virtual void	get (const InfoHash &key, GetCallbackSimple cb, DoneCallback donecb={}, Value::Filter &&f={}, Where &&w={}) override

virtual void	get (const InfoHash &key, GetCallbackSimple cb, DoneCallbackSimple donecb, Value::Filter &&f={}, Where &&w={}) override

virtual void	query (const InfoHash &key, QueryCallback cb, DoneCallback done_cb={}, Query &&q={}) override

virtual void	query (const InfoHash &key, QueryCallback cb, DoneCallbackSimple done_cb={}, Query &&q={}) override

std::vector< Sp< Value > >	getLocal (const InfoHash &key, const Value::Filter &f={}) const override

Sp< Value >	getLocalById (const InfoHash &key, Value::Id vid) const override

void	put (const InfoHash &key, Sp< Value >, DoneCallback cb=nullptr, time_point created=time_point::max(), bool permanent=false) override

void	put (const InfoHash &key, const Sp< Value > &v, DoneCallbackSimple cb, time_point created=time_point::max(), bool permanent=false) override

void	put (const InfoHash &key, Value &&v, DoneCallback cb=nullptr, time_point created=time_point::max(), bool permanent=false) override

void	put (const InfoHash &key, Value &&v, DoneCallbackSimple cb, time_point created=time_point::max(), bool permanent=false) override

std::vector< Sp< Value > >	getPut (const InfoHash &) const override

Sp< Value >	getPut (const InfoHash &, const Value::Id &) const override

bool	cancelPut (const InfoHash &, const Value::Id &) override

size_t	listen (const InfoHash &, ValueCallback, Value::Filter={}, Where={}) override

size_t	listen (const InfoHash &key, GetCallback cb, Value::Filter f={}, Where w={}) override

size_t	listen (const InfoHash &key, GetCallbackSimple cb, Value::Filter f={}, Where w={}) override

bool	cancelListen (const InfoHash &, size_t token) override

void	connectivityChanged (sa_family_t) override

void	connectivityChanged () override

std::vector< NodeExport >	exportNodes () const override

std::vector< ValuesExport >	exportValues () const override

void	importValues (const std::vector< ValuesExport > &) override

void	saveState (const std::string &path) const

void	loadState (const std::string &path)

NodeStats	getNodesStats (sa_family_t af) const override

std::string	getStorageLog () const override

std::string	getStorageLog (const InfoHash &) const override

std::string	getRoutingTablesLog (sa_family_t) const override

std::string	getSearchesLog (sa_family_t) const override

std::string	getSearchLog (const InfoHash &, sa_family_t af=AF_UNSPEC) const override

void	dumpTables () const override

std::vector< unsigned >	getNodeMessageStats (bool in=false) override

void	setStorageLimit (size_t limit=DEFAULT_STORAGE_LIMIT) override

size_t	getStorageLimit () const override

std::pair< size_t, size_t >	getStoreSize () const override

std::vector< SockAddr >	getPublicAddress (sa_family_t family=0) override

void	pushNotificationReceived (const std::map< std::string, std::string > &) override

void	resubscribe (unsigned)

Public Member Functions inherited from dht::DhtInterface
	DhtInterface (const Logger &l)

	DhtInterface (const std::shared_ptr< Logger > &l)

void	addOnConnectedCallback (std::function< void()> cb)

virtual void	setLoggers (LogMethod error={}, LogMethod warn={}, LogMethod debug={})

virtual void	setLogger (const Logger &l)

virtual void	setLogger (const std::shared_ptr< Logger > &l)

virtual void	setLogFilter (const InfoHash &f)

virtual void	setPushNotificationToken (const std::string &)

Additional Inherited Members
Public Types inherited from dht::DhtInterface
using	Status = NodeStatus

using	NodeExport = dht::NodeExport

Protected Attributes inherited from dht::DhtInterface
std::shared_ptr< Logger >	logger_ {}

std::queue< std::function< void()> >	onConnectCallbacks_ {}

Detailed Description

Main Dht class. Provides a Distributed Hash Table node.

Must be given open UDP sockets and ::periodic must be called regularly.

Definition at line 62 of file dht.h.

Constructor & Destructor Documentation

◆ Dht()

dht::Dht::Dht	(	std::unique_ptr< net::DatagramSocket > &&	sock,
		const Config &	config,
		const Sp< Logger > &	l = `{}`
	)

Initialise the Dht with two open sockets (for IPv4 and IP6) and an ID for the node.

Member Function Documentation

◆ cancelPut()

bool dht::Dht::cancelPut	(	const InfoHash &	,
		const Value::Id &
	)

overridevirtual

Stop any put/announce operation at the given location, for the value with the given id.

Implements dht::DhtInterface.

◆ connectivityChanged()

void dht::Dht::connectivityChanged ( sa_family_t )

overridevirtual

Inform the DHT of lower-layer connectivity changes. This will cause the DHT to assume a public IP address change. The DHT will recontact neighbor nodes, re-register for listen ops etc.

Implements dht::DhtInterface.

◆ exportNodes()

std::vector<NodeExport> dht::Dht::exportNodes ( ) const

overridevirtual

Get the list of good nodes for local storage saving purposes The list is ordered to minimize the back-to-work delay.

Implements dht::DhtInterface.

◆ get()

virtual void dht::Dht::get	(	const InfoHash &	key,
		GetCallback	cb,
		DoneCallback	donecb = `{}`,
		Value::Filter &&	f = `{}`,
		Where &&	w = `{}`
	)

overridevirtual

Get a value by searching on all available protocols (IPv4, IPv6), and call the provided get callback when values are found at key. The operation will start as soon as the node is connected to the network.

Parameters

cb	a function called when new values are found on the network. It should return false to stop the operation.
donecb	a function called when the operation is complete. cb and donecb won't be called again afterward.
f	a filter function used to prefilter values.

Implements dht::DhtInterface.

◆ getLocal()

std::vector<Sp<Value> > dht::Dht::getLocal	(	const InfoHash &	key,
		const Value::Filter &	f = `{}`
	)		const

overridevirtual

Get locally stored data for the given hash.

Implements dht::DhtInterface.

◆ getLocalById()

Sp<Value> dht::Dht::getLocalById	(	const InfoHash &	key,
		Value::Id	vid
	)		const

overridevirtual

Get locally stored data for the given key and value id.

Implements dht::DhtInterface.

◆ getNodeId()

const InfoHash& dht::Dht::getNodeId ( ) const

inlineoverridevirtual

Get the ID of the node.

Implements dht::DhtInterface.

Definition at line 78 of file dht.h.

◆ getPut() [1/2]

std::vector<Sp<Value> > dht::Dht::getPut ( const InfoHash & ) const

overridevirtual

Get data currently being put at the given hash.

Implements dht::DhtInterface.

◆ getPut() [2/2]

Sp<Value> dht::Dht::getPut	(	const InfoHash &	,
		const Value::Id &
	)		const

overridevirtual

Get data currently being put at the given hash with the given id.

Implements dht::DhtInterface.

◆ getStatus()

NodeStatus dht::Dht::getStatus ( sa_family_t af ) const

inlineoverridevirtual

Get the current status of the node for the given family.

Implements dht::DhtInterface.

Definition at line 85 of file dht.h.

◆ getStoreSize()

std::pair<size_t, size_t> dht::Dht::getStoreSize ( ) const

inlineoverridevirtual

Returns the total memory usage of stored values and the number of stored values.

Implements dht::DhtInterface.

Definition at line 313 of file dht.h.

◆ insertNode()

void dht::Dht::insertNode	(	const InfoHash &	id,
		const SockAddr &
	)

overridevirtual

Insert a node in the main routing table. The node is not pinged, so this should be used to bootstrap efficiently from previously known nodes.

Implements dht::DhtInterface.

◆ isRunning()

bool dht::Dht::isRunning ( sa_family_t af = 0 ) const

overridevirtual

Returns true if the node is running (have access to an open socket).

af: address family. If non-zero, will return true if the node is running for the provided family.

Implements dht::DhtInterface.

◆ listen() [1/2]

size_t dht::Dht::listen	(	const InfoHash &	,
		ValueCallback	,
		Value::Filter	= `{}`,
		Where	= `{}`
	)

overridevirtual

Listen on the network for any changes involving a specified hash. The node will register to receive updates from relevent nodes when new values are added or removed.

Returns: a token to cancel the listener later.

Implements dht::DhtInterface.

◆ listen() [2/2]

size_t dht::Dht::listen	(	const InfoHash &	,
		GetCallback	,
		Value::Filter	= `{}`,
		Where	w = `{}`
	)

inlineoverridevirtual

Listen on the network for any changes involving a specified hash. The node will register to receive updates from relevent nodes when new values are added or removed.

Returns: a token to cancel the listener later.

Implements dht::DhtInterface.

Definition at line 248 of file dht.h.

◆ pushNotificationReceived()

void dht::Dht::pushNotificationReceived ( const std::map< std::string, std::string > & data )

inlineoverridevirtual

Call linked callback with a push notification

Parameters

notification to process

Implements dht::DhtInterface.

Definition at line 319 of file dht.h.

◆ put()

void dht::Dht::put	(	const InfoHash &	key,
		Sp< Value >	,
		DoneCallback	cb = `nullptr`,
		time_point	created = `time_point::max()`,
		bool	permanent = `false`
	)

overridevirtual

Announce a value on all available protocols (IPv4, IPv6).

The operation will start as soon as the node is connected to the network. The done callback will be called once, when the first announce succeeds, or fails.

Implements dht::DhtInterface.

◆ query()

virtual void dht::Dht::query	(	const InfoHash &	key,
		QueryCallback	cb,
		DoneCallback	done_cb = `{}`,
		Query &&	q = `{}`
	)

overridevirtual

Similar to Dht::get, but sends a Query to filter data remotely.

Parameters

key	the key for which to query data for.
cb	a function called when new values are found on the network. It should return false to stop the operation.
done_cb	a function called when the operation is complete. cb and done_cb won't be called again afterward.
q	a query used to filter values on the remotes before they send a response.

Implements dht::DhtInterface.

◆ setStorageLimit()

void dht::Dht::setStorageLimit ( size_t limit = DEFAULT_STORAGE_LIMIT )

inlineoverridevirtual

Set the in-memory storage limit in bytes

Implements dht::DhtInterface.

Definition at line 302 of file dht.h.

◆ shutdown()

void dht::Dht::shutdown	(	ShutdownCallback	cb,
		bool	stop = `false`
	)

overridevirtual

Performs final operations before quitting.

Implements dht::DhtInterface.

◆ updateStatus()

NodeStatus dht::Dht::updateStatus ( sa_family_t af )

overridevirtual

Get the current status of the node for the given family.

Reimplemented from dht::DhtInterface.

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

/home/abuild/rpmbuild/BUILD/opendht-2.4.4/include/opendht/dht.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Dht()

Member Function Documentation

◆ cancelPut()

◆ connectivityChanged()

◆ exportNodes()

◆ get()

◆ getLocal()

◆ getLocalById()

◆ getNodeId()

◆ getPut() [1/2]

◆ getPut() [2/2]

◆ getStatus()

◆ getStoreSize()

◆ insertNode()

◆ isRunning()

◆ listen() [1/2]

◆ listen() [2/2]

◆ pushNotificationReceived()

◆ put()

◆ query()

◆ setStorageLimit()

◆ shutdown()

◆ updateStatus()