mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-01-01 10:56:15 -05:00
ea3311eb2a
* made PeerCallback() pass a bdId rather than a bdNodeId. * disabled recursive mutex to test!. git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@3857 b45a01b8-16f6-495d-af2f-9b41ad6348cc
189 lines
5.1 KiB
C++
189 lines
5.1 KiB
C++
#ifndef BIT_DHT_INTERFACE_H
|
|
#define BIT_DHT_INTERFACE_H
|
|
|
|
/*
|
|
* bitdht/bdiface.h
|
|
*
|
|
* BitDHT: An Flexible DHT library.
|
|
*
|
|
* Copyright 2010 by Robert Fernie
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License Version 3 as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
* USA.
|
|
*
|
|
* Please report all bugs and problems to "bitdht@lunamutt.com".
|
|
*
|
|
*/
|
|
|
|
#include <iosfwd>
|
|
#include <map>
|
|
#include <string>
|
|
#include <inttypes.h>
|
|
|
|
#include "util/bdnet.h"
|
|
|
|
/*
|
|
* Functions and Classes required for Interfacing with the BitDht.
|
|
* This should be the sole header file required to talk to Dht.
|
|
* ... though setting it up will require including udpbitdht.h as well.
|
|
*
|
|
*/
|
|
|
|
#define BITDHT_KEY_LEN 20
|
|
#define BITDHT_KEY_INTLEN 5
|
|
#define BITDHT_KEY_BITLEN 160
|
|
|
|
|
|
|
|
|
|
#define BITDHT_MAX_PKTSIZE 1024
|
|
|
|
#define BITDHT_TTL 64
|
|
|
|
#define BITDHT_SEARCH_ONE_SHOT 1
|
|
#define BITDHT_SEARCH_REPEATING 2
|
|
|
|
class bdNodeId
|
|
{
|
|
public:
|
|
unsigned char data[BITDHT_KEY_LEN];
|
|
};
|
|
|
|
class bdMetric: public bdNodeId {};
|
|
|
|
class bdId
|
|
{
|
|
public:
|
|
|
|
bdId();
|
|
bdId(bdNodeId in_id, struct sockaddr_in in_addr);
|
|
|
|
struct sockaddr_in addr;
|
|
bdNodeId id;
|
|
};
|
|
|
|
#define BITDHT_LIKELY_SAME_NO 0x00000000
|
|
#define BITDHT_LIKELY_SAME_YES 0x00000001
|
|
#define BITDHT_LIKELY_SAME_PORT_CHANGED 0x00000002
|
|
#define BITDHT_LIKELY_SAME_LOC_CHANGED 0x00000004
|
|
#define BITDHT_LIKELY_SAME_IDENTICAL 0x00000008
|
|
|
|
|
|
class bdDhtFunctions
|
|
{
|
|
public:
|
|
|
|
// bdDhtFunctions();
|
|
/* setup variables */
|
|
virtual uint16_t bdNumBuckets() = 0;
|
|
virtual uint16_t bdNodesPerBucket() = 0; /* used for query + bdspace */
|
|
virtual uint16_t bdBucketBitSize() = 0;
|
|
|
|
virtual int bdDistance(const bdNodeId *n1, const bdNodeId *n2, bdMetric *metric) = 0;
|
|
virtual int bdBucketDistance(const bdNodeId *n1, const bdNodeId *n2) = 0;
|
|
virtual int bdBucketDistance(const bdMetric *metric) = 0;
|
|
|
|
virtual uint32_t bdLikelySameNode(const bdId *id1, const bdId *id2) = 0;
|
|
|
|
virtual void bdRandomMidId(const bdNodeId *target, const bdNodeId *other, bdNodeId *mid) = 0;
|
|
|
|
virtual void bdPrintId(std::ostream &out, const bdId *a) = 0;
|
|
virtual void bdPrintNodeId(std::ostream &out, const bdNodeId *a) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/* peer flags
|
|
* order is important!
|
|
* higher bits = more priority.
|
|
* BITDHT_PEER_STATUS_RECVPONG
|
|
* BITDHT_PEER_STATUS_RECVNODES
|
|
* BITDHT_PEER_STATUS_RECVHASHES
|
|
* BITDHT_PEER_STATUS_DHT_ENGINE (dbXXxx)
|
|
* BITDHT_PEER_STATUS_DHT_APPL (XXRSxx)
|
|
* BITDHT_PEER_STATUS_DHT_VERSION (XXxx50)
|
|
*
|
|
*/
|
|
|
|
#define BITDHT_PEER_STATUS_MASK_RECVD 0x000000ff
|
|
#define BITDHT_PEER_STATUS_MASK_DHT 0x0000ff00
|
|
|
|
#define BITDHT_PEER_STATUS_RECV_PONG 0x00000001
|
|
#define BITDHT_PEER_STATUS_RECV_NODES 0x00000002
|
|
#define BITDHT_PEER_STATUS_RECV_HASHES 0x00000004
|
|
|
|
#define BITDHT_PEER_STATUS_DHT_ENGINE 0x00000100
|
|
#define BITDHT_PEER_STATUS_DHT_APPL 0x00000200
|
|
#define BITDHT_PEER_STATUS_DHT_VERSION 0x00000400
|
|
|
|
|
|
/* Status options */
|
|
#define BITDHT_QUERY_READY 1
|
|
#define BITDHT_QUERY_QUERYING 2
|
|
#define BITDHT_QUERY_FAILURE 3
|
|
#define BITDHT_QUERY_FOUND_CLOSEST 4
|
|
#define BITDHT_QUERY_PEER_UNREACHABLE 5
|
|
#define BITDHT_QUERY_SUCCESS 6
|
|
|
|
/* Query Flags */
|
|
#define BITDHT_QFLAGS_NONE 0
|
|
#define BITDHT_QFLAGS_DISGUISE 1
|
|
#define BITDHT_QFLAGS_DO_IDLE 2
|
|
#define BITDHT_QFLAGS_INTERNAL 4 // means it runs through startup.
|
|
|
|
class BitDhtCallback
|
|
{
|
|
public:
|
|
// ~BitDhtCallback();
|
|
|
|
// dummy cos not needed for standard dht behaviour;
|
|
virtual int dhtNodeCallback(const bdId * /*id*/, uint32_t /*peerflags*/) { return 0; }
|
|
|
|
// must be implemented.
|
|
virtual int dhtPeerCallback(const bdId *id, uint32_t status) = 0;
|
|
virtual int dhtValueCallback(const bdNodeId *id, std::string key, uint32_t status) = 0;
|
|
};
|
|
|
|
|
|
class BitDhtInterface
|
|
{
|
|
public:
|
|
|
|
/***** Request Lookup (DHT Peer & Keyword) *****/
|
|
virtual void addFindNode(bdNodeId *id, uint32_t mode) = 0;
|
|
virtual void removeFindNode(bdNodeId *id) = 0;
|
|
virtual void findDhtValue(bdNodeId *id, std::string key, uint32_t mode) = 0;
|
|
|
|
/***** Add / Remove Callback Clients *****/
|
|
virtual void addCallback(BitDhtCallback *cb) = 0;
|
|
virtual void removeCallback(BitDhtCallback *cb) = 0;
|
|
|
|
/***** Get Results Details *****/
|
|
virtual int getDhtPeerAddress(const bdNodeId *id, struct sockaddr_in &from) = 0;
|
|
virtual int getDhtValue(const bdNodeId *id, std::string key, std::string &value) = 0;
|
|
|
|
/* stats and Dht state */
|
|
virtual int startDht() = 0;
|
|
virtual int stopDht() = 0;
|
|
virtual int stateDht() = 0; /* STOPPED, STARTING, ACTIVE, FAILED */
|
|
virtual uint32_t statsNetworkSize() = 0;
|
|
virtual uint32_t statsBDVersionSize() = 0; /* same version as us! */
|
|
};
|
|
|
|
#endif
|
|
|