src/third_party/libjingle/source/talk/base/asynctcpsocket.h

   1 /*
   2  * libjingle
   3  * Copyright 2004--2010, 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_BASE_ASYNCTCPSOCKET_H_
  29 #define TALK_BASE_ASYNCTCPSOCKET_H_
  30
  31 #include "talk/base/asyncpacketsocket.h"
  32 #include "talk/base/scoped_ptr.h"
  33 #include "talk/base/socketfactory.h"
  34
  35 namespace talk_base {
  36
  37 // Simulates UDP semantics over TCP.  Send and Recv packet sizes
  38 // are preserved, and drops packets silently on Send, rather than
  39 // buffer them in user space.
  40 class AsyncTCPSocketBase : public AsyncPacketSocket {
  41  public:
  42   AsyncTCPSocketBase(AsyncSocket* socket, bool listen, size_t max_packet_size);
  43   virtual ~AsyncTCPSocketBase();
  44
  45   // Pure virtual methods to send and recv data.
  46   virtual int Send(const void *pv, size_t cb,
  47                    const talk_base::PacketOptions& options) = 0;
  48   virtual void ProcessInput(char* data, size_t* len) = 0;
  49   // Signals incoming connection.
  50   virtual void HandleIncomingConnection(AsyncSocket* socket) = 0;
  51
  52   virtual SocketAddress GetLocalAddress() const;
  53   virtual SocketAddress GetRemoteAddress() const;
  54   virtual int SendTo(const void *pv, size_t cb, const SocketAddress& addr,
  55                      const talk_base::PacketOptions& options);
  56   virtual int Close();
  57
  58   virtual State GetState() const;
  59   virtual int GetOption(Socket::Option opt, int* value);
  60   virtual int SetOption(Socket::Option opt, int value);
  61   virtual int GetError() const;
  62   virtual void SetError(int error);
  63
  64  protected:
  65   // Binds and connects |socket| and creates AsyncTCPSocket for
  66   // it. Takes ownership of |socket|. Returns NULL if bind() or
  67   // connect() fail (|socket| is destroyed in that case).
  68   static AsyncSocket* ConnectSocket(AsyncSocket* socket,
  69                                     const SocketAddress& bind_address,
  70                                     const SocketAddress& remote_address);
  71   virtual int SendRaw(const void* pv, size_t cb);
  72   int FlushOutBuffer();
  73   // Add data to |outbuf_|.
  74   void AppendToOutBuffer(const void* pv, size_t cb);
  75
  76   // Helper methods for |outpos_|.
  77   bool IsOutBufferEmpty() const { return outpos_ == 0; }
  78   void ClearOutBuffer() { outpos_ = 0; }
  79
  80  private:
  81   // Called by the underlying socket
  82   void OnConnectEvent(AsyncSocket* socket);
  83   void OnReadEvent(AsyncSocket* socket);
  84   void OnWriteEvent(AsyncSocket* socket);
  85   void OnCloseEvent(AsyncSocket* socket, int error);
  86
  87   scoped_ptr<AsyncSocket> socket_;
  88   bool listen_;
  89   char* inbuf_, * outbuf_;
  90   size_t insize_, inpos_, outsize_, outpos_;
  91
  92   DISALLOW_EVIL_CONSTRUCTORS(AsyncTCPSocketBase);
  93 };
  94
  95 class AsyncTCPSocket : public AsyncTCPSocketBase {
  96  public:
  97   // Binds and connects |socket| and creates AsyncTCPSocket for
  98   // it. Takes ownership of |socket|. Returns NULL if bind() or
  99   // connect() fail (|socket| is destroyed in that case).
 100   static AsyncTCPSocket* Create(AsyncSocket* socket,
 101                                 const SocketAddress& bind_address,
 102                                 const SocketAddress& remote_address);
 103   AsyncTCPSocket(AsyncSocket* socket, bool listen);
 104   virtual ~AsyncTCPSocket() {}
 105
 106   virtual int Send(const void* pv, size_t cb,
 107                    const talk_base::PacketOptions& options);
 108   virtual void ProcessInput(char* data, size_t* len);
 109   virtual void HandleIncomingConnection(AsyncSocket* socket);
 110
 111  private:
 112   DISALLOW_EVIL_CONSTRUCTORS(AsyncTCPSocket);
 113 };
 114
 115 }  // namespace talk_base
 116
 117 #endif  // TALK_BASE_ASYNCTCPSOCKET_H_