1f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch/* 2f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * libjingle 3f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * Copyright 2004--2005, Google Inc. 4f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 5f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * Redistribution and use in source and binary forms, with or without 6f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * modification, are permitted provided that the following conditions are met: 7f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 8f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 1. Redistributions of source code must retain the above copyright notice, 9f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * this list of conditions and the following disclaimer. 10f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 2. Redistributions in binary form must reproduce the above copyright notice, 11f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * this list of conditions and the following disclaimer in the documentation 12f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * and/or other materials provided with the distribution. 13f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 3. The name of the author may not be used to endorse or promote products 14f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * derived from this software without specific prior written permission. 15f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * 16f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 19f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 22f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 23f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 24f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 25f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch */ 27f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 28f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#ifndef TALK_P2P_BASE_RELAYPORT_H_ 29f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#define TALK_P2P_BASE_RELAYPORT_H_ 30f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 31dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include <deque> 32f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include <string> 33dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen#include <utility> 34f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include <vector> 35dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen 36f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/p2p/base/port.h" 37f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#include "talk/p2p/base/stunrequest.h" 38f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 39f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochnamespace cricket { 40f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 41f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochextern const std::string RELAY_PORT_TYPE; 42f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass RelayEntry; 43f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass RelayConnection; 44f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 45f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// Communicates using an allocated port on the relay server. For each 46f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// remote candidate that we try to send data to a RelayEntry instance 47f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// is created. The RelayEntry will try to reach the remote destination 48f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// by connecting to all available server addresses in a pre defined 49f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// order with a small delay in between. When a connection is 50f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch// successful all other connection attemts are aborted. 51f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdochclass RelayPort : public Port { 52f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch public: 53f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch typedef std::pair<talk_base::Socket::Option, int> OptionValue; 54f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 55f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // RelayPort doesn't yet do anything fancy in the ctor. 56f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch static RelayPort* Create( 57dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen talk_base::Thread* thread, talk_base::PacketSocketFactory* factory, 58dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen talk_base::Network* network, uint32 ip, int min_port, int max_port, 59dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen const std::string& username, const std::string& password, 60dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen const std::string& magic_cookie) { 61dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen return new RelayPort(thread, factory, network, ip, min_port, max_port, 62f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch username, password, magic_cookie); 63f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch } 64f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual ~RelayPort(); 65f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 66f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void AddServerAddress(const ProtocolAddress& addr); 67f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void AddExternalAddress(const ProtocolAddress& addr); 68f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 69f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch const std::vector<OptionValue>& options() const { return options_; } 70f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch const std::string& magic_cookie() const { return magic_cookie_; } 71f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool HasMagicCookie(const char* data, size_t size); 72f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 73f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual void PrepareAddress(); 74f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual Connection* CreateConnection(const Candidate& address, 75f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch CandidateOrigin origin); 76f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual int SetOption(talk_base::Socket::Option opt, int value); 77f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual int GetError(); 78f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 79f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch const ProtocolAddress * ServerAddress(size_t index) const; 80f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool IsReady() { return ready_; } 81f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 82f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Used for testing. 83f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch sigslot::signal1<const ProtocolAddress*> SignalConnectFailure; 84f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch sigslot::signal1<const ProtocolAddress*> SignalSoftTimeout; 85f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 86f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch protected: 87dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen RelayPort(talk_base::Thread* thread, talk_base::PacketSocketFactory* factory, 88dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen talk_base::Network*, uint32 ip, int min_port, int max_port, 89dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen const std::string& username, const std::string& password, 90dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen const std::string& magic_cookie); 91dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen bool Init(); 92dc0f95d653279beabeb9817299e2902918ba123eKristian Monsen 93f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void SetReady(); 94f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 95f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch virtual int SendTo(const void* data, size_t size, 96f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch const talk_base::SocketAddress& addr, bool payload); 97f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 98f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch // Dispatches the given packet to the port or connection as appropriate. 99f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch void OnReadPacket(const char* data, size_t size, 100f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch const talk_base::SocketAddress& remote_addr); 101f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 102f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch private: 103f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch friend class RelayEntry; 104f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 105f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch std::deque<ProtocolAddress> server_addr_; 106f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch bool ready_; 107f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch std::vector<RelayEntry*> entries_; 108f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch std::vector<OptionValue> options_; 109f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch std::string magic_cookie_; 110f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch int error_; 111f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch}; 112f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 113f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch} // namespace cricket 114f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch 115f74420b3285b9fe04a7e00aa3b8c0ab07ea344bcBen Murdoch#endif // TALK_P2P_BASE_RELAYPORT_H_ 116