Home | History | Annotate | Download | only in base 
      1 /*
      2  * libjingle
      3  * Copyright 2004--2005, Google Inc.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are met:
      7  *
      8  *  1. Redistributions of source code must retain the above copyright notice,
      9  *     this list of conditions and the following disclaimer.
     10  *  2. Redistributions in binary form must reproduce the above copyright notice,
     11  *     this list of conditions and the following disclaimer in the documentation
     12  *     and/or other materials provided with the distribution.
     13  *  3. The name of the author may not be used to endorse or promote products
     14  *     derived from this software without specific prior written permission.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
     17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
     19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     26  */
     27 
     28 #ifndef TALK_P2P_BASE_TCPPORT_H_
     29 #define TALK_P2P_BASE_TCPPORT_H_
     30 
     31 #include <string>
     32 #include <list>
     33 #include "talk/base/asyncpacketsocket.h"
     34 #include "talk/p2p/base/port.h"
     35 
     36 namespace cricket {
     37 
     38 class TCPConnection;
     39 
     40 // Communicates using a local TCP port.
     41 //
     42 // This class is designed to allow subclasses to take advantage of the
     43 // connection management provided by this class.  A subclass should take of all
     44 // packet sending and preparation, but when a packet is received, it should
     45 // call this TCPPort::OnReadPacket (3 arg) to dispatch to a connection.
     46 class TCPPort : public Port {
     47  public:
     48   static TCPPort* Create(talk_base::Thread* thread,
     49                          talk_base::PacketSocketFactory* factory,
     50                          talk_base::Network* network,
     51                          const talk_base::IPAddress& ip,
     52                          int min_port, int max_port,
     53                          const std::string& username,
     54                          const std::string& password,
     55                          bool allow_listen) {
     56     TCPPort* port = new TCPPort(thread, factory, network,
     57                                 ip, min_port, max_port,
     58                                 username, password, allow_listen);
     59     if (!port->Init()) {
     60       delete port;
     61       port = NULL;
     62     }
     63     return port;
     64   }
     65   virtual ~TCPPort();
     66 
     67   virtual Connection* CreateConnection(const Candidate& address,
     68                                        CandidateOrigin origin);
     69 
     70   virtual void PrepareAddress();
     71 
     72   virtual int GetOption(talk_base::Socket::Option opt, int* value);
     73   virtual int SetOption(talk_base::Socket::Option opt, int value);
     74   virtual int GetError();
     75 
     76  protected:
     77   TCPPort(talk_base::Thread* thread, talk_base::PacketSocketFactory* factory,
     78           talk_base::Network* network, const talk_base::IPAddress& ip,
     79           int min_port, int max_port, const std::string& username,
     80           const std::string& password, bool allow_listen);
     81   bool Init();
     82 
     83   // Handles sending using the local TCP socket.
     84   virtual int SendTo(const void* data, size_t size,
     85                      const talk_base::SocketAddress& addr, bool payload);
     86 
     87   // Accepts incoming TCP connection.
     88   void OnNewConnection(talk_base::AsyncPacketSocket* socket,
     89                        talk_base::AsyncPacketSocket* new_socket);
     90 
     91  private:
     92   struct Incoming {
     93     talk_base::SocketAddress addr;
     94     talk_base::AsyncPacketSocket* socket;
     95   };
     96 
     97   talk_base::AsyncPacketSocket* GetIncoming(
     98       const talk_base::SocketAddress& addr, bool remove = false);
     99 
    100   // Receives packet signal from the local TCP Socket.
    101   void OnReadPacket(talk_base::AsyncPacketSocket* socket,
    102                     const char* data, size_t size,
    103                     const talk_base::SocketAddress& remote_addr);
    104 
    105   void OnReadyToSend(talk_base::AsyncPacketSocket* socket);
    106 
    107   void OnAddressReady(talk_base::AsyncPacketSocket* socket,
    108                       const talk_base::SocketAddress& address);
    109 
    110   // TODO: Is this still needed?
    111   bool incoming_only_;
    112   bool allow_listen_;
    113   talk_base::AsyncPacketSocket* socket_;
    114   int error_;
    115   std::list<Incoming> incoming_;
    116 
    117   friend class TCPConnection;
    118 };
    119 
    120 class TCPConnection : public Connection {
    121  public:
    122   // Connection is outgoing unless socket is specified
    123   TCPConnection(TCPPort* port, const Candidate& candidate,
    124                 talk_base::AsyncPacketSocket* socket = 0);
    125   virtual ~TCPConnection();
    126 
    127   virtual int Send(const void* data, size_t size);
    128   virtual int GetError();
    129 
    130   talk_base::AsyncPacketSocket* socket() { return socket_; }
    131 
    132  private:
    133   void OnConnect(talk_base::AsyncPacketSocket* socket);
    134   void OnClose(talk_base::AsyncPacketSocket* socket, int error);
    135   void OnReadPacket(talk_base::AsyncPacketSocket* socket,
    136                     const char* data, size_t size,
    137                     const talk_base::SocketAddress& remote_addr);
    138   void OnReadyToSend(talk_base::AsyncPacketSocket* socket);
    139 
    140   talk_base::AsyncPacketSocket* socket_;
    141   int error_;
    142 
    143   friend class TCPPort;
    144 };
    145 
    146 }  // namespace cricket
    147 
    148 #endif  // TALK_P2P_BASE_TCPPORT_H_
    149