mirror of
https://github.com/RetroShare/RetroShare.git
synced 2024-10-01 02:35:48 -04:00
4d2907efed
- now distant messages stay in outgoing box until notified to be received. - fixed serialisation bug git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@7293 b45a01b8-16f6-495d-af2f-9b41ad6348cc
252 lines
8.8 KiB
C++
252 lines
8.8 KiB
C++
/*
|
|
* libretroshare/src/services: p3grouter.h
|
|
*
|
|
* Services for RetroShare.
|
|
*
|
|
* Copyright 2013 by Cyril Soler
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License Version 2 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 "csoler@users.sourceforge.net".
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <map>
|
|
#include <queue>
|
|
#include <fstream>
|
|
|
|
#include "retroshare/rsgrouter.h"
|
|
#include "retroshare/rstypes.h"
|
|
|
|
#include "services/p3service.h"
|
|
#include "pqi/p3cfgmgr.h"
|
|
|
|
#include "groutertypes.h"
|
|
#include "groutermatrix.h"
|
|
#include "grouteritems.h"
|
|
//#include "groutercache.h"
|
|
|
|
// To be put in pqi/p3cfgmgr.h
|
|
//
|
|
static const uint32_t CONFIG_TYPE_GROUTER = 0x0016 ;
|
|
|
|
class p3LinkMgr ;
|
|
class RsGRouterPublishKeyItem ;
|
|
class RsGRouterACKItem ;
|
|
|
|
class p3GRouter: public RsGRouter, public p3Service, public p3Config
|
|
{
|
|
public:
|
|
p3GRouter(p3ServiceControl *sc,p3LinkMgr *lm) ;
|
|
|
|
//===================================================//
|
|
// Router clients business //
|
|
//===================================================//
|
|
|
|
// This method allows to associate client ids (that are saved to disk) to client objects deriving
|
|
// from GRouterClientService. The various services are responsible for regstering themselves to the
|
|
// global router, with consistent ids. The services are stored in a map, and arriving objects are
|
|
// passed on the correct service depending on the client id of the key they are reaching.
|
|
//
|
|
bool registerClientService(const GRouterServiceId& id,GRouterClientService *service) ;
|
|
|
|
// Use this method to register/unregister a key that the global router will
|
|
// forward in the network, so that is can be a possible destination for
|
|
// global messages.
|
|
//
|
|
// key : The key that is published
|
|
// fingerp : Fingerprint of the key to encrypt the data.
|
|
// desc_str : Any fixed length string (< 20 characters) to descript the address in words.
|
|
// client_id: id of the client service to send the traffic to.
|
|
// To obtain a client id, the service must register using the previous method.
|
|
//
|
|
// Unregistering a key might not have an instantaneous effect, so the client is responsible for
|
|
// discarding traffic that might later come for this key.
|
|
//
|
|
bool registerKey(const GRouterKeyId& key, const GRouterServiceId& client_id,const std::string& description_string) ;
|
|
bool unregisterKey(const GRouterKeyId& key) ;
|
|
|
|
//===================================================//
|
|
// Client/server request services //
|
|
//===================================================//
|
|
|
|
// Sends an item to the given destination. The router takes ownership of
|
|
// the memory. That means item_data will be erase on return. The returned id should be
|
|
// remembered by the client, so that he knows when the data has been received.
|
|
// The client id is supplied so that the client can be notified when the data has been received.
|
|
//
|
|
void sendData(const GRouterKeyId& destination,const GRouterServiceId& client_id, RsGRouterGenericDataItem *item,GRouterMsgPropagationId& id) ;
|
|
|
|
// Sends an ACK to the origin of the msg. This is used to notify for
|
|
// unfound route, or message correctly received, depending on the particular situation.
|
|
//
|
|
void sendACK(const RsPeerId& peer,GRouterMsgPropagationId mid, uint32_t flags) ;
|
|
|
|
//===================================================//
|
|
// Interface with RsGRouter //
|
|
//===================================================//
|
|
|
|
// debug info from routing matrix
|
|
// - list of known key ids
|
|
// - list of clues/time_stamp for each key.
|
|
// - real time routing probabilities
|
|
//
|
|
virtual bool getRoutingMatrixInfo(GRouterRoutingMatrixInfo& info) ;
|
|
|
|
// debug info from routing cache
|
|
// - Cache Items
|
|
// * which message ids
|
|
// * directions
|
|
// * timestamp
|
|
// * message type
|
|
// - Cache state (memory size, etc)
|
|
//
|
|
virtual bool getRoutingCacheInfo(std::vector<GRouterRoutingCacheInfo>& info) ;
|
|
|
|
//===================================================//
|
|
// Derived from p3Service //
|
|
//===================================================//
|
|
|
|
virtual RsServiceInfo getServiceInfo()
|
|
{
|
|
return RsServiceInfo(RS_SERVICE_TYPE_GROUTER,
|
|
SERVICE_INFO_APP_NAME,
|
|
SERVICE_INFO_APP_MAJOR_VERSION,
|
|
SERVICE_INFO_APP_MINOR_VERSION,
|
|
SERVICE_INFO_MIN_MAJOR_VERSION,
|
|
SERVICE_INFO_MIN_MINOR_VERSION) ;
|
|
}
|
|
|
|
void setDebugEnabled(bool b) { _debug_enabled = b ; }
|
|
protected:
|
|
//===================================================//
|
|
// Routing method handling //
|
|
//===================================================//
|
|
|
|
// Calls
|
|
// - autoWash()
|
|
// - packet handling methods
|
|
// - matrix updates
|
|
//
|
|
virtual int tick() ;
|
|
|
|
static const std::string SERVICE_INFO_APP_NAME ;
|
|
static const uint16_t SERVICE_INFO_APP_MAJOR_VERSION = 1;
|
|
static const uint16_t SERVICE_INFO_APP_MINOR_VERSION = 0;
|
|
static const uint16_t SERVICE_INFO_MIN_MAJOR_VERSION = 1;
|
|
static const uint16_t SERVICE_INFO_MIN_MINOR_VERSION = 0;
|
|
|
|
private:
|
|
class nullstream: public std::ostream {};
|
|
|
|
std::ostream& grouter_debug() const
|
|
{
|
|
static nullstream null ;
|
|
|
|
return _debug_enabled?(std::cerr):null;
|
|
}
|
|
|
|
void autoWash() ;
|
|
void routePendingObjects() ;
|
|
void handleIncoming() ;
|
|
void debugDump() ;
|
|
|
|
// utility functions
|
|
//
|
|
static uint32_t computeBranchingFactor(const std::vector<RsPeerId>& friends,uint32_t dist) ;
|
|
std::set<uint32_t> computeRoutingFriends(const std::vector<RsPeerId>& friends,const std::vector<float>& probas,uint32_t N) ;
|
|
static float computeMatrixContribution(float base,uint32_t time_shift,float probability) ;
|
|
static time_t computeNextTimeDelay(time_t duration) ;
|
|
|
|
void locked_notifyClientAcknowledged(const GRouterMsgPropagationId& msg_id,const GRouterServiceId& service_id) const ;
|
|
|
|
uint32_t computeRandomDistanceIncrement(const RsPeerId& pid,const GRouterKeyId& destination_id) ;
|
|
|
|
//===================================================//
|
|
// p3Config methods //
|
|
//===================================================//
|
|
|
|
// Load/save the routing info, the pending items in transit, and the config variables.
|
|
//
|
|
virtual bool loadList(std::list<RsItem*>& items) ;
|
|
virtual bool saveList(bool& cleanup,std::list<RsItem*>& items) ;
|
|
|
|
virtual RsSerialiser *setupSerialiser() ;
|
|
|
|
//===================================================//
|
|
// Debug methods //
|
|
//===================================================//
|
|
|
|
// Prints the internal state of the router, for debug purpose.
|
|
//
|
|
void debug_dump() ;
|
|
|
|
// Stores the routing info
|
|
// - list of known key ids
|
|
// - list of clues/time_stamp for each key.
|
|
// - real time routing probabilities
|
|
//
|
|
GRouterMatrix _routing_matrix ;
|
|
|
|
// Stores the routing events.
|
|
// - ongoing requests, waiting for return ACK
|
|
// - pending items
|
|
// Both a stored in 2 different lists, to allow a more efficient handling.
|
|
//
|
|
std::map<GRouterMsgPropagationId, GRouterRoutingInfo> _pending_messages;// pending messages
|
|
|
|
// Stores the keys which identify the router's node. For each key, a structure holds:
|
|
// - the client service
|
|
// - flags
|
|
// - usage time stamps
|
|
//
|
|
std::map<GRouterKeyId, GRouterPublishedKeyInfo> _owned_key_ids ;
|
|
|
|
// Registered services. These are known to the different peers with a common id,
|
|
// so it's important to keep consistency here. This map is volatile, and re-created at each startup of
|
|
// the software, when newly created services register themselves.
|
|
|
|
std::map<GRouterServiceId,GRouterClientService *> _registered_services ;
|
|
|
|
// Data handling ethods
|
|
//
|
|
void handleRecvDataItem(RsGRouterGenericDataItem *item);
|
|
void handleRecvACKItem(RsGRouterACKItem *item);
|
|
|
|
// Pointers to other RS objects
|
|
//
|
|
p3ServiceControl *mServiceControl ;
|
|
p3LinkMgr *mLinkMgr ;
|
|
|
|
// Multi-thread protection mutex.
|
|
//
|
|
RsMutex grMtx ;
|
|
|
|
// config update/save variables
|
|
bool _changed ;
|
|
bool _debug_enabled ;
|
|
|
|
time_t _last_autowash_time ;
|
|
time_t _last_matrix_update_time ;
|
|
time_t _last_debug_output_time ;
|
|
time_t _last_config_changed ;
|
|
|
|
uint64_t _random_salt ;
|
|
};
|
|
|
|
template<typename T> p3GRouter::nullstream& operator<<(p3GRouter::nullstream& ns,const T&) { return ns ; }
|