mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-02-18 05:44:14 -05:00
66 lines
1.9 KiB
C
66 lines
1.9 KiB
C
|
#ifndef RETROSHARE_TURTLE_GUI_INTERFACE_H
|
||
|
|
#define RETROSHARE_TURTLE_GUI_INTERFACE_H
|
||
|
|
|
||
|
|
/*
|
||
|
|
* libretroshare/src/rsiface: rsturtle.h
|
||
|
|
*
|
||
|
|
* RetroShare C++ Interface.
|
||
|
|
*
|
||
|
|
* Copyright 2009 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"
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
#include <inttypes.h>
|
||
|
|
#include <string>
|
||
|
|
#include <list>
|
||
|
|
|
||
|
|
class RsTurtle;
|
||
|
|
extern RsTurtle *rsTurtle ;
|
||
|
|
|
||
|
|
typedef uint32_t TurtleRequestId ;
|
||
|
|
|
||
|
|
// Interface class for turtle hopping.
|
||
|
|
//
|
||
|
|
// This class mainly interacts with the turtle router, that is responsible
|
||
|
|
// for routing turtle packets between peers, accepting/forwarding search
|
||
|
|
// requests and dowloading files.
|
||
|
|
//
|
||
|
|
// As seen from here, the interface is really simple.
|
||
|
|
//
|
||
|
|
class RsTurtle
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
RsTurtle() {}
|
||
|
|
virtual ~RsTurtle() {}
|
||
|
|
|
||
|
|
// Lauches a search request through the pipes, and immediately returns
|
||
|
|
// the request id, which will be further used by the gui to store results
|
||
|
|
// as they come back.
|
||
|
|
//
|
||
|
|
virtual TurtleRequestId turtleSearch(const std::string& match_string) = 0 ;
|
||
|
|
|
||
|
|
// Launches a complete download file operation: diggs one or more
|
||
|
|
// tunnels. Launches an exception if an error occurs during the
|
||
|
|
// initialization process.
|
||
|
|
//
|
||
|
|
virtual void turtleDownload(const std::string& file_hash) = 0 ;
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif
|