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

   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_ASYNCUDPSOCKET_H_
  29 #define TALK_BASE_ASYNCUDPSOCKET_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 // Provides the ability to receive packets asynchronously.  Sends are not
  38 // buffered since it is acceptable to drop packets under high load.
  39 class AsyncUDPSocket : public AsyncPacketSocket {
  40  public:
  41   // Binds |socket| and creates AsyncUDPSocket for it. Takes ownership
  42   // of |socket|. Returns NULL if bind() fails (|socket| is destroyed
  43   // in that case).
  44   static AsyncUDPSocket* Create(AsyncSocket* socket,
  45                                 const SocketAddress& bind_address);
  46   // Creates a new socket for sending asynchronous UDP packets using an
  47   // asynchronous socket from the given factory.
  48   static AsyncUDPSocket* Create(SocketFactory* factory,
  49                                 const SocketAddress& bind_address);
  50   explicit AsyncUDPSocket(AsyncSocket* socket);
  51   virtual ~AsyncUDPSocket();
  52
  53   virtual SocketAddress GetLocalAddress() const;
  54   virtual SocketAddress GetRemoteAddress() const;
  55   virtual int Send(const void *pv, size_t cb,
  56                    const talk_base::PacketOptions& options);
  57   virtual int SendTo(const void *pv, size_t cb, const SocketAddress& addr,
  58                      const talk_base::PacketOptions& options);
  59   virtual int Close();
  60
  61   virtual State GetState() const;
  62   virtual int GetOption(Socket::Option opt, int* value);
  63   virtual int SetOption(Socket::Option opt, int value);
  64   virtual int GetError() const;
  65   virtual void SetError(int error);
  66
  67  private:
  68   // Called when the underlying socket is ready to be read from.
  69   void OnReadEvent(AsyncSocket* socket);
  70   // Called when the underlying socket is ready to send.
  71   void OnWriteEvent(AsyncSocket* socket);
  72
  73   scoped_ptr<AsyncSocket> socket_;
  74   char* buf_;
  75   size_t size_;
  76 };
  77
  78 }  // namespace talk_base
  79
  80 #endif  // TALK_BASE_ASYNCUDPSOCKET_H_