2012-01-11 18:01:29 -05:00
|
|
|
#ifndef RSGNP_H
|
|
|
|
#define RSGNP_H
|
|
|
|
|
2012-01-18 18:20:53 -05:00
|
|
|
/*
|
|
|
|
* libretroshare/src/gxs: rsgnp.h
|
|
|
|
*
|
2012-02-12 10:29:49 -05:00
|
|
|
* Network Exchange Service interface for RetroShare.
|
2012-01-18 18:20:53 -05:00
|
|
|
*
|
|
|
|
* Copyright 2011-2011 by Robert Fernie, Christopher Evi-Prker
|
|
|
|
*
|
|
|
|
* 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 "retroshare@lunamutt.com".
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2012-01-15 08:07:31 -05:00
|
|
|
#include <set>
|
2012-01-18 18:20:53 -05:00
|
|
|
#include <string>
|
2012-01-16 16:52:22 -05:00
|
|
|
#include <time.h>
|
|
|
|
#include <stdlib.h>
|
2012-01-18 18:20:53 -05:00
|
|
|
#include <list>
|
|
|
|
#include <map>
|
2012-01-15 08:07:31 -05:00
|
|
|
|
2012-02-12 10:18:05 -05:00
|
|
|
#include "services/p3service.h"
|
2012-06-11 17:56:23 -04:00
|
|
|
#include "rsgds.h"
|
2012-01-19 18:32:27 -05:00
|
|
|
|
2012-01-11 18:01:29 -05:00
|
|
|
/*!
|
2012-01-18 18:20:53 -05:00
|
|
|
* Retroshare General Network Exchange Service: \n
|
2012-01-19 18:32:27 -05:00
|
|
|
* Interface:
|
2012-02-12 10:18:05 -05:00
|
|
|
* - This provides a module to service peer's requests for GXS messages \n
|
2012-01-19 18:32:27 -05:00
|
|
|
* and also request GXS messages from other peers. \n
|
2012-02-12 10:18:05 -05:00
|
|
|
* - The general mode of operation is to sychronise all messages/grps between
|
|
|
|
* peers
|
|
|
|
*
|
|
|
|
* The interface is sparse as this service is mostly making the requests to other GXS components
|
|
|
|
*
|
|
|
|
* Groups:
|
2012-06-05 10:46:18 -04:00
|
|
|
* - As this is where exchanges occur between peers, this is also where group's relationships
|
2012-02-12 10:18:05 -05:00
|
|
|
* should get resolved as far as
|
|
|
|
* - Per implemented GXS there are a set of rules which will determine whether data is transferred
|
|
|
|
* between any set of groups
|
|
|
|
*
|
|
|
|
* 1 allow transfers to any group
|
|
|
|
* 2 transfers only between group
|
|
|
|
* - the also group matrix settings which is by default everyone can transfer to each other
|
2012-01-11 18:01:29 -05:00
|
|
|
*/
|
2012-07-05 17:26:14 -04:00
|
|
|
class RsNetworkExchangeService
|
2012-01-11 18:01:29 -05:00
|
|
|
{
|
|
|
|
public:
|
2012-01-15 08:07:31 -05:00
|
|
|
|
2012-07-12 16:18:58 -04:00
|
|
|
RsNetworkExchangeService(){ return;}
|
2012-06-11 17:56:23 -04:00
|
|
|
|
2012-01-18 18:20:53 -05:00
|
|
|
/*!
|
2012-02-12 10:18:05 -05:00
|
|
|
* Use this to set how far back synchronisation of messages should take place
|
2012-06-05 10:46:18 -04:00
|
|
|
* @param age the max age a sync item can to be allowed in a synchronisation
|
2012-01-18 18:20:53 -05:00
|
|
|
*/
|
2012-06-05 10:46:18 -04:00
|
|
|
virtual void setSyncAge(uint32_t age) = 0;
|
2012-01-15 08:07:31 -05:00
|
|
|
|
2012-04-01 17:10:55 -04:00
|
|
|
/*!
|
2012-06-05 10:46:18 -04:00
|
|
|
* Explicitly requests all the groups contained by a peer
|
|
|
|
* Circumvents polling of peers for message
|
2012-04-01 17:10:55 -04:00
|
|
|
* @param peerId id of peer
|
|
|
|
*/
|
|
|
|
virtual void requestGroupsOfPeer(const std::string& peerId) = 0;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* get messages of a peer for a given group id, this circumvents the normal
|
|
|
|
* polling of peers for messages of given group id
|
|
|
|
* @param peerId Id of peer
|
|
|
|
* @param grpId id of group to request messages for
|
|
|
|
*/
|
2012-06-26 15:52:01 -04:00
|
|
|
virtual void requestMessagesOfPeer(const std::string& peerId, const std::string& grpId) = 0;
|
2012-04-01 17:10:55 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* Initiates a search through the network
|
|
|
|
* This returns messages which contains the search terms set in RsGxsSearch
|
|
|
|
* @param search contains search terms of requested from service
|
|
|
|
* @param hops how far into friend tree for search
|
|
|
|
* @return search token that can be redeemed later, implementation should indicate how this should be used
|
|
|
|
*/
|
2012-07-05 17:26:14 -04:00
|
|
|
//virtual int searchMsgs(RsGxsSearch* search, uint8_t hops = 1, bool retrieve = 0) = 0;
|
2012-04-01 17:10:55 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* Initiates a search of groups through the network which goes
|
2012-06-16 09:59:40 -04:00
|
|
|
* a given number of hops deep into your friend network
|
2012-04-01 17:10:55 -04:00
|
|
|
* @param search contains search term requested from service
|
|
|
|
* @param hops number of hops deep into peer network
|
|
|
|
* @return search token that can be redeemed later
|
|
|
|
*/
|
2012-07-05 17:26:14 -04:00
|
|
|
//virtual int searchGrps(RsGxsSearch* search, uint8_t hops = 1, bool retrieve = 0) = 0;
|
2012-04-01 17:10:55 -04:00
|
|
|
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* pauses synchronisation of subscribed groups and request for group id
|
|
|
|
* from peers
|
|
|
|
* @param enabled set to false to disable pause, and true otherwise
|
|
|
|
*/
|
2012-07-12 16:18:58 -04:00
|
|
|
virtual void pauseSynchronisation(bool enabled) = 0;
|
2012-04-01 17:10:55 -04:00
|
|
|
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Request for this message is sent through to peers on your network
|
|
|
|
* and how many hops from them you've indicated
|
|
|
|
* @param msgId the messages to retrieve
|
|
|
|
* @return request token to be redeemed
|
|
|
|
*/
|
2012-06-11 17:56:23 -04:00
|
|
|
virtual int requestMsg(const std::string& msgId, uint8_t hops) = 0;
|
2012-04-01 17:10:55 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* Request for this group is sent through to peers on your network
|
|
|
|
* and how many hops from them you've indicated
|
|
|
|
* @param enabled set to false to disable pause, and true otherwise
|
|
|
|
* @return request token to be redeemed
|
|
|
|
*/
|
2012-06-26 15:52:01 -04:00
|
|
|
virtual int requestGrp(const std::list<std::string>& grpId, uint8_t hops) = 0;
|
2012-04-01 17:10:55 -04:00
|
|
|
|
|
|
|
|
2012-01-11 18:01:29 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // RSGNP_H
|