Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2025-06-07 06:02:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

documenting: pqi_base.h

Browse source 
- could be improved, if anyone knows more on  core rs networking (below p3services and cachestrapper)

git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@2720 b45a01b8-16f6-495d-af2f-9b41ad6348cc
This commit is contained in:
chrisparker126 2010-04-15 11:39:54 +00:00
parent e2c8053eee
commit 7aa487e2b6
1 changed files with 74 additions and 230 deletions
Download patch file Download diff file Expand all files Collapse all files

304
libretroshare/src/pqi/pqi_base.h
View file

@ -48,168 +48,13 @@
int getPQIsearchId(); int getPQIsearchId();
int fixme(char *str, int n); int fixme(char *str, int n);
//! controlling data rates
/*!
#if 0 /* removing old stuff */ * For controlling data rates.
struct chan_id
{
int route[10];
};
typedef unsigned long SearchId; /* unsigned 32 bits */
typedef struct chan_id ChanId;
/* basic worker fns on cids */
int pqicid_clear(ChanId *cid);
int pqicid_copy(const ChanId *cid, ChanId *newcid);
int pqicid_cmp(const ChanId *cid1, ChanId *cid2);
// So the basic pqi interface defines
//
// 1) Person -> reference object
// 2) RsItem
// 3) PQInterface
// which defines:
// - send/recieve objs
// - send/recieve files
//
// This is then extended to
// 4) SInterface
// which seperates the data into providing a basic search interface.
// chat/messages/files/search objs.
//
// TODO IN THIS CLASS.
// 1) Add serialisation.... (later)
// 2) reduce base interface to the minimum.
// 3) Convert cid -> std::stack.
// Base for all Security/Id/Certificate schemes.
// The list of these must be maintained seperately
// from the RsItems....
// Person - includes
// 1) name + signature (unique id)
// 2) address + timestamps of connections.
// 3) status
// 4) groups.
//
// only requires certificate. to complete...
#define PERSON_STATUS_VALID 0x0001
#define PERSON_STATUS_ACCEPTED 0x0002
#define PERSON_STATUS_INUSE 0x0004
#define PERSON_STATUS_LISTENING 0x0008
#define PERSON_STATUS_CONNECTED 0x0010
#define PERSON_STATUS_WILL_LISTEN 0x0020
#define PERSON_STATUS_WILL_CONNECT 0x0040
#define PERSON_STATUS_MANUAL 0x0080
#define PERSON_STATUS_FIREWALLED 0x0100
#define PERSON_STATUS_FORWARDED 0x0200
#define PERSON_STATUS_LOCAL 0x0400
#define PERSON_STATUS_TRUSTED 0x0800
/* some extra flags for advising the gui....
* have no affect on the pqi networking.
*/ */
#define PERSON_STATUS_INCHAT 0x1000
#define PERSON_STATUS_INMSG 0x2000
class Person
{
public:
Person();
virtual ~Person();
std::string Name();
void Name(std::string);
// Signature needs to be defined.
virtual std::string Signature() { return Name(); };
// These operate on the status.
bool Valid();
void Valid(bool);
bool Accepted();
void Accepted(bool);
bool InUse();
void InUse(bool);
bool Listening();
void Listening(bool);
bool Connected();
void Connected(bool);
bool WillListen();
void WillListen(bool);
bool WillConnect();
void WillConnect(bool);
bool Manual();
void Manual(bool);
bool Firewalled();
void Firewalled(bool);
bool Forwarded();
void Forwarded(bool);
bool Local();
void Local(bool);
bool Trusted();
void Trusted(bool);
/* GUI Flags */
bool InChat();
void InChat(bool);
bool InMessage();
void InMessage(bool);
unsigned int Status();
void Status(unsigned int s);
int addGroup(std::string);
int removeGroup(std::string);
bool Group(std::string);
int cidpop();
void cidpush(int id);
/* Dynamic Address Foundation */
bool hasDHT();
std::string getDHTId();
void setDHT(struct sockaddr_in addr, unsigned int flags);
// public for the moment.
struct sockaddr_in lastaddr, localaddr, serveraddr;
std::string dynDNSaddr;
bool dhtFound;
unsigned int dhtFlags;
struct sockaddr_in dhtaddr;
time_t lc_timestamp; // last connect timestamp
time_t lr_timestamp; // last receive timestamp
time_t nc_timestamp; // next connect timestamp.
time_t nc_timeintvl; // next connect time interval.
ChanId cid; // to get to the correct pqissl.
int trustLvl; /* new field */
private:
std::string name;
unsigned int status;
std::list<std::string> groups;
};
#endif /* removing old stuff */
class RateInterface class RateInterface
{ {
// controlling data rates.
public: public:
RateInterface() RateInterface()
@ -255,14 +100,14 @@ float bw_in, bw_out, bwMax_in, bwMax_out;
}; };
/*********************** PQI INTERFACE ******************************\
* The basic exchange interface.
* This inherits the RateInterface, as Bandwidth control
* is a critical to a networked application.
*
*/
class NetInterface; class NetInterface;
//! The basic exchange interface.
/*!
*
* This inherits the RateInterface, as Bandwidth control
* is critical to a networked application.
**/
class PQInterface: public RateInterface class PQInterface: public RateInterface
{ {
public: public:
@ -272,7 +117,9 @@ virtual ~PQInterface() { return; }
virtual int SendItem(RsItem *) = 0; virtual int SendItem(RsItem *) = 0;
virtual RsItem *GetItem() = 0; virtual RsItem *GetItem() = 0;
// also there are tick + person id functions. /**
* also there are tick + person id functions.
*/
virtual int tick() { return 0; } virtual int tick() { return 0; }
virtual int status() { return 0; } virtual int status() { return 0; }
virtual std::string PeerId() { return peerId; } virtual std::string PeerId() { return peerId; }
@ -294,10 +141,6 @@ const uint32_t PQI_CONNECT_UDP = 0x0002;
const uint32_t PQI_CONNECT_TUNNEL = 0x0003; const uint32_t PQI_CONNECT_TUNNEL = 0x0003;
const uint32_t PQI_CONNECT_DO_NEXT_ATTEMPT = 0x0004; const uint32_t PQI_CONNECT_DO_NEXT_ATTEMPT = 0x0004;
/********************** Binary INTERFACE ****************************
* This defines the binary interface used by Network/loopback/file
* interfaces
*/
#define BIN_FLAGS_NO_CLOSE 0x0001 #define BIN_FLAGS_NO_CLOSE 0x0001
#define BIN_FLAGS_READABLE 0x0002 #define BIN_FLAGS_READABLE 0x0002
@ -305,44 +148,66 @@ const uint32_t PQI_CONNECT_DO_NEXT_ATTEMPT = 0x0004;
#define BIN_FLAGS_NO_DELETE 0x0008 #define BIN_FLAGS_NO_DELETE 0x0008
#define BIN_FLAGS_HASH_DATA 0x0010 #define BIN_FLAGS_HASH_DATA 0x0010
/*!
* This defines the binary interface used by Network/loopback/file
* interfaces
* e.g. sending binary data to file or to memory or even through a socket
*/
class BinInterface class BinInterface
{ {
public: public:
BinInterface() { return; } BinInterface() { return; }
virtual ~BinInterface() { return; } virtual ~BinInterface() { return; }
/**
* To be called loop, for updating state
*/
virtual int tick() = 0; virtual int tick() = 0;
/**
* Sends data to a prescribed location (implementation dependent)
*@param data what will be sent
*@param len the size of data pointed to in memory
*/
virtual int senddata(void *data, int len) = 0; virtual int senddata(void *data, int len) = 0;
/**
* reads data from a prescribed location (implementation dependent)
*@param data what will be sent
*@param len the size of data pointed to in memory
*/
virtual int readdata(void *data, int len) = 0; virtual int readdata(void *data, int len) = 0;
/**
* Is more particular the case of the sending data through a socket (internet)
*/
virtual int netstatus() = 0; virtual int netstatus() = 0;
virtual int isactive() = 0; virtual int isactive() = 0;
virtual bool moretoread() = 0; virtual bool moretoread() = 0;
virtual bool cansend() = 0; virtual bool cansend() = 0;
/* method for streamer to shutdown bininterface */ /**
* method for streamer to shutdown bininterface
**/
virtual int close() = 0; virtual int close() = 0;
/* if hashing data */ /**
* If hashing data
**/
virtual std::string gethash() = 0; virtual std::string gethash() = 0;
/**
* Number of bytes read/sent
*/
virtual uint64_t bytecount() { return 0; } virtual uint64_t bytecount() { return 0; }
/* used by pqistreamer to limit transfers */ /**
* used by pqistreamer to limit transfers
**/
virtual bool bandwidthLimited() { return true; } virtual bool bandwidthLimited() { return true; }
}; };
/********************** Network INTERFACE ***************************
* This defines the Network interface used by sockets/SSL/XPGP
* interfaces
*
* NetInterface: very pure interface, so no tick....
*
* It is passed a pointer to a PQInterface *parent,
* this is used to notify the system of Connect/Disconnect Events.
*
* Below are the Events for callback.
*/
static const int NET_CONNECT_RECEIVED = 1; static const int NET_CONNECT_RECEIVED = 1;
static const int NET_CONNECT_SUCCESS = 2; static const int NET_CONNECT_SUCCESS = 2;
@ -357,17 +222,32 @@ static const uint32_t NET_PARAM_CONNECT_TIMEOUT = 3;
//static const uint32_t NET_PARAM_CONNECT_TUNNEL_RELAY_PEER_ID = 5; //static const uint32_t NET_PARAM_CONNECT_TUNNEL_RELAY_PEER_ID = 5;
//static const uint32_t NET_PARAM_CONNECT_TUNNEL_DEST_PEER_ID = 6; //static const uint32_t NET_PARAM_CONNECT_TUNNEL_DEST_PEER_ID = 6;
/*!
* ******************** Network INTERFACE ***************************
* This defines the Network interface used by sockets/SSL/XPGP
* interfaces
*
* NetInterface: very pure interface, so no tick....
*
* It is passed a pointer to a PQInterface *parent,
* this is used to notify the system of Connect/Disconnect Events.
*
* Below are the Events for callback.
**/
class NetInterface class NetInterface
{ {
public: public:
/**
* @param p_in used to notify system of connect/disconnect events
*/
NetInterface(PQInterface *p_in, std::string id) NetInterface(PQInterface *p_in, std::string id)
:p(p_in), peerId(id) { return; } :p(p_in), peerId(id) { return; }
virtual ~NetInterface() virtual ~NetInterface()
{ return; } { return; }
// virtual int tick() = 0; // Already defined for BinInterface.
virtual int connect(struct sockaddr_in raddr) = 0; virtual int connect(struct sockaddr_in raddr) = 0;
virtual int listen() = 0; virtual int listen() = 0;
virtual int stoplistening() = 0; virtual int stoplistening() = 0;
@ -386,7 +266,14 @@ private:
std::string peerId; std::string peerId;
}; };
//! network binary interface (abstract)
/**
* Should be used for networking and connecting to addresses
*
* @see pqissl
* @see NetInterface
* @see BinInterface
**/
class NetBinInterface: public NetInterface, public BinInterface class NetBinInterface: public NetInterface, public BinInterface
{ {
public: public:
@ -400,49 +287,6 @@ virtual ~NetBinInterface() { return; }
#define CERTSIGNLEN 16 /* actual byte length of signature */ #define CERTSIGNLEN 16 /* actual byte length of signature */
#define PQI_PEERID_LENGTH 32 /* When expanded into a string */ #define PQI_PEERID_LENGTH 32 /* When expanded into a string */
#if 0
class certsign
{
public:
bool operator<(const certsign &ref) const;
bool operator==(const certsign &ref) const;
char data[CERTSIGNLEN];
};
// IDS aren't inportant in the base class.
// EXCEPT FOR MAYBE THE FLAGS.
// These are OR'ed together.
const int PQI_ITEM_FLAG_NEW = 0x001;
const int PQI_ITEM_FLAG_LOCAL = 0x002;
const int PQI_ITEM_FLAG_PRIVATE = 0x004;
const int PQI_ITEM_TYPE_ITEM = 0x000;
const int PQI_ITEM_TYPE_FILEITEM = 0x001;
const int PQI_ITEM_TYPE_SEARCHITEM = 2;
const int PQI_ITEM_TYPE_CHATITEM = 3;
const int PQI_ITEM_TYPE_INFOITEM = 5;
const int PQI_ITEM_TYPE_COMMANDITEM = 6;
const int PQI_ITEM_TYPE_AUTODISCITEM = 7;
const int PQI_ITEM_TYPE_TUNNELITEM = 777;
const int PQI_ITEM_TYPE_TUNNELINITITEM = 778;
// Sub Type.
const int PQI_FI_SUBTYPE_GENERAL = 1;
const int PQI_FI_SUBTYPE_DATA = 2;
const int PQI_FI_SUBTYPE_CANCELRECV = 3;
const int PQI_FI_SUBTYPE_CANCELSEND = 4;
const int PQI_FI_SUBTYPE_REQUEST = 5;
const int PQI_FI_SUBTYPE_TRANSFER = 6;
const int PQI_FI_SUBTYPE_RATE = 7;
const int PQI_FI_SUBTYPE_ERROR = 8;
const int PQI_FD_FLAG_ENDSTREAM = 1;
#endif /* removing old stuff */
#endif // PQI_BASE_ITEM_HEADER #endif // PQI_BASE_ITEM_HEADER