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_BASE_ASYNCPACKETSOCKET_H_
     29 #define TALK_BASE_ASYNCPACKETSOCKET_H_
     30 
     31 #include "talk/base/sigslot.h"
     32 #include "talk/base/socket.h"
     33 
     34 namespace talk_base {
     35 
     36 // Provides the ability to receive packets asynchronously. Sends are not
     37 // buffered since it is acceptable to drop packets under high load.
     38 class AsyncPacketSocket : public sigslot::has_slots<> {
     39  public:
     40   enum State {
     41     STATE_CLOSED,
     42     STATE_BINDING,
     43     STATE_BOUND,
     44     STATE_CONNECTING,
     45     STATE_CONNECTED
     46   };
     47 
     48   AsyncPacketSocket() { }
     49   virtual ~AsyncPacketSocket() { }
     50 
     51   // Returns current local address. Address may be set to NULL if the
     52   // socket is not bound yet (GetState() returns STATE_BINDING).
     53   virtual SocketAddress GetLocalAddress() const = 0;
     54 
     55   // Returns remote address. Returns zeroes if this is not a client TCP socket.
     56   virtual SocketAddress GetRemoteAddress() const = 0;
     57 
     58   // Send a packet.
     59   virtual int Send(const void *pv, size_t cb) = 0;
     60   virtual int SendTo(const void *pv, size_t cb, const SocketAddress& addr) = 0;
     61 
     62   // Close the socket.
     63   virtual int Close() = 0;
     64 
     65   // Returns current state of the socket.
     66   virtual State GetState() const = 0;
     67 
     68   // Get/set options.
     69   virtual int GetOption(Socket::Option opt, int* value) = 0;
     70   virtual int SetOption(Socket::Option opt, int value) = 0;
     71 
     72   // Get/Set current error.
     73   // TODO: Remove SetError().
     74   virtual int GetError() const = 0;
     75   virtual void SetError(int error) = 0;
     76 
     77   // Emitted each time a packet is read. Used only for UDP and
     78   // connected TCP sockets.
     79   sigslot::signal4<AsyncPacketSocket*, const char*, size_t,
     80                    const SocketAddress&> SignalReadPacket;
     81 
     82   // Emitted when the socket is currently able to send.
     83   sigslot::signal1<AsyncPacketSocket*> SignalReadyToSend;
     84 
     85   // Emitted after address for the socket is allocated, i.e. binding
     86   // is finished. State of the socket is changed from BINDING to BOUND
     87   // (for UDP and server TCP sockets) or CONNECTING (for client TCP
     88   // sockets).
     89   sigslot::signal2<AsyncPacketSocket*, const SocketAddress&> SignalAddressReady;
     90 
     91   // Emitted for client TCP sockets when state is changed from
     92   // CONNECTING to CONNECTED.
     93   sigslot::signal1<AsyncPacketSocket*> SignalConnect;
     94 
     95   // Emitted for client TCP sockets when state is changed from
     96   // CONNECTED to CLOSED.
     97   sigslot::signal2<AsyncPacketSocket*, int> SignalClose;
     98 
     99   // Used only for listening TCP sockets.
    100   sigslot::signal2<AsyncPacketSocket*, AsyncPacketSocket*> SignalNewConnection;
    101 
    102  private:
    103   DISALLOW_EVIL_CONSTRUCTORS(AsyncPacketSocket);
    104 };
    105 
    106 }  // namespace talk_base
    107 
    108 #endif  // TALK_BASE_ASYNCPACKETSOCKET_H_
    109