summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'Swiften/FileTransfer/FileTransferTransporter.h')
-rw-r--r--Swiften/FileTransfer/FileTransferTransporter.h89
1 files changed, 47 insertions, 42 deletions
diff --git a/Swiften/FileTransfer/FileTransferTransporter.h b/Swiften/FileTransfer/FileTransferTransporter.h
index b7b7090..e0ffc87 100644
--- a/Swiften/FileTransfer/FileTransferTransporter.h
+++ b/Swiften/FileTransfer/FileTransferTransporter.h
@@ -1,6 +1,6 @@
/*
- * Copyright (c) 2013 Remko Tronçon
- * Licensed under the GNU General Public License.
+ * Copyright (c) 2013-2016 Isode Limited.
+ * All rights reserved.
* See the COPYING file for more information.
*/
@@ -8,48 +8,53 @@
#include <vector>
-#include <boost/optional/optional_fwd.hpp>
+#include <boost/optional/optional.hpp>
+#include <boost/signals2.hpp>
-#include <Swiften/Elements/JingleS5BTransportPayload.h>
#include <Swiften/Base/API.h>
-#include <Swiften/Base/boost_bsignals.h>
+#include <Swiften/Elements/JingleS5BTransportPayload.h>
namespace Swift {
- class TransportSession;
- class ErrorPayload;
- class ReadBytestream;
- class WriteBytestream;
-
- class SWIFTEN_API FileTransferTransporter {
- public:
- virtual ~FileTransferTransporter();
-
- virtual void startGeneratingLocalCandidates() = 0;
- virtual void stopGeneratingLocalCandidates() = 0;
-
- virtual void addRemoteCandidates(
- const std::vector<JingleS5BTransportPayload::Candidate>&) = 0;
- virtual void startTryingRemoteCandidates() = 0;
- virtual void stopTryingRemoteCandidates() = 0;
-
- virtual void startActivatingProxy(const JID& proxy) = 0;
- virtual void stopActivatingProxy() = 0;
-
- virtual boost::shared_ptr<TransportSession> createIBBSendSession(
- const std::string& sessionID, unsigned int blockSize, boost::shared_ptr<ReadBytestream>) = 0;
- virtual boost::shared_ptr<TransportSession> createIBBReceiveSession(
- const std::string& sessionID, unsigned long long size, boost::shared_ptr<WriteBytestream>) = 0;
- virtual boost::shared_ptr<TransportSession> createRemoteCandidateSession(
- boost::shared_ptr<ReadBytestream>) = 0;
- virtual boost::shared_ptr<TransportSession> createRemoteCandidateSession(
- boost::shared_ptr<WriteBytestream>) = 0;
- virtual boost::shared_ptr<TransportSession> createLocalCandidateSession(
- boost::shared_ptr<ReadBytestream>) = 0;
- virtual boost::shared_ptr<TransportSession> createLocalCandidateSession(
- boost::shared_ptr<WriteBytestream>) = 0;
-
- boost::signal<void (const std::string& /* sessionID */, const std::vector<JingleS5BTransportPayload::Candidate>&)> onLocalCandidatesGenerated;
- boost::signal<void (const std::string& /* sessionID */, const boost::optional<JingleS5BTransportPayload::Candidate>&)> onRemoteCandidateSelectFinished;
- boost::signal<void (const std::string& /* sessionID */, boost::shared_ptr<ErrorPayload>)> onProxyActivated;
- };
+ class TransportSession;
+ class ErrorPayload;
+ class ReadBytestream;
+ class WriteBytestream;
+
+ /**
+ * @brief The FileTransferTransporter class is an abstract factory definition
+ * to generate SOCKS5 bytestream transports or IBB bytestreams for use in file
+ * transfers.
+ */
+ class SWIFTEN_API FileTransferTransporter {
+ public:
+ virtual ~FileTransferTransporter();
+
+ virtual void startGeneratingLocalCandidates() = 0;
+ virtual void stopGeneratingLocalCandidates() = 0;
+
+ virtual void addRemoteCandidates(
+ const std::vector<JingleS5BTransportPayload::Candidate>&, const std::string&) = 0;
+ virtual void startTryingRemoteCandidates() = 0;
+ virtual void stopTryingRemoteCandidates() = 0;
+
+ virtual void startActivatingProxy(const JID& proxy) = 0;
+ virtual void stopActivatingProxy() = 0;
+
+ virtual std::shared_ptr<TransportSession> createIBBSendSession(
+ const std::string& sessionID, unsigned int blockSize, std::shared_ptr<ReadBytestream>) = 0;
+ virtual std::shared_ptr<TransportSession> createIBBReceiveSession(
+ const std::string& sessionID, unsigned long long size, std::shared_ptr<WriteBytestream>) = 0;
+ virtual std::shared_ptr<TransportSession> createRemoteCandidateSession(
+ std::shared_ptr<ReadBytestream>, const JingleS5BTransportPayload::Candidate& candidate) = 0;
+ virtual std::shared_ptr<TransportSession> createRemoteCandidateSession(
+ std::shared_ptr<WriteBytestream>, const JingleS5BTransportPayload::Candidate& candidate) = 0;
+ virtual std::shared_ptr<TransportSession> createLocalCandidateSession(
+ std::shared_ptr<ReadBytestream>, const JingleS5BTransportPayload::Candidate& candidate) = 0;
+ virtual std::shared_ptr<TransportSession> createLocalCandidateSession(
+ std::shared_ptr<WriteBytestream>, const JingleS5BTransportPayload::Candidate& candidate) = 0;
+
+ boost::signals2::signal<void (const std::string& /* sessionID */, const std::vector<JingleS5BTransportPayload::Candidate>&, const std::string& /* dstAddr */)> onLocalCandidatesGenerated;
+ boost::signals2::signal<void (const std::string& /* sessionID */, const boost::optional<JingleS5BTransportPayload::Candidate>&)> onRemoteCandidateSelectFinished;
+ boost::signals2::signal<void (const std::string& /* sessionID */, std::shared_ptr<ErrorPayload>)> onProxyActivated;
+ };
}