src/third_party/libjingle/source/talk/base/asyncfile.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_ASYNCFILE_H__
  29 #define TALK_BASE_ASYNCFILE_H__
  30
  31 #include "talk/base/sigslot.h"
  32
  33 namespace talk_base {
  34
  35 // Provides the ability to perform file I/O asynchronously.
  36 // TODO: Create a common base class with AsyncSocket.
  37 class AsyncFile {
  38  public:
  39   AsyncFile();
  40   virtual ~AsyncFile();
  41
  42   // Determines whether the file will receive read events.
  43   virtual bool readable() = 0;
  44   virtual void set_readable(bool value) = 0;
  45
  46   // Determines whether the file will receive write events.
  47   virtual bool writable() = 0;
  48   virtual void set_writable(bool value) = 0;
  49
  50   sigslot::signal1<AsyncFile*> SignalReadEvent;
  51   sigslot::signal1<AsyncFile*> SignalWriteEvent;
  52   sigslot::signal2<AsyncFile*, int> SignalCloseEvent;
  53 };
  54
  55 }  // namespace talk_base
  56
  57 #endif  // TALK_BASE_ASYNCFILE_H__