FileDescriptor.hxx
上传用户:sy_wanhua
上传日期:2013-07-25
资源大小:3048k
文件大小:8k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(FILEDESCRIPTOR_DOT_H)
  2. #define FILEDESCRIPTOR_DOT_H
  3. /* ====================================================================
  4.  * The Vovida Software License, Version 1.0 
  5.  * 
  6.  * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
  7.  * 
  8.  * Redistribution and use in source and binary forms, with or without
  9.  * modification, are permitted provided that the following conditions
  10.  * are met:
  11.  * 
  12.  * 1. Redistributions of source code must retain the above copyright
  13.  *    notice, this list of conditions and the following disclaimer.
  14.  * 
  15.  * 2. Redistributions in binary form must reproduce the above copyright
  16.  *    notice, this list of conditions and the following disclaimer in
  17.  *    the documentation and/or other materials provided with the
  18.  *    distribution.
  19.  * 
  20.  * 3. The names "VOCAL", "Vovida Open Communication Application Library",
  21.  *    and "Vovida Open Communication Application Library (VOCAL)" must
  22.  *    not be used to endorse or promote products derived from this
  23.  *    software without prior written permission. For written
  24.  *    permission, please contact vocal@vovida.org.
  25.  *
  26.  * 4. Products derived from this software may not be called "VOCAL", nor
  27.  *    may "VOCAL" appear in their name, without prior written
  28.  *    permission of Vovida Networks, Inc.
  29.  * 
  30.  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
  31.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
  33.  * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
  34.  * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
  35.  * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
  36.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  37.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  38.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  39.  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  41.  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  42.  * DAMAGE.
  43.  * 
  44.  * ====================================================================
  45.  * 
  46.  * This software consists of voluntary contributions made by Vovida
  47.  * Networks, Inc. and many individuals on behalf of Vovida Networks,
  48.  * Inc.  For more information on Vovida Networks, Inc., please see
  49.  * <http://www.vovida.org/>.
  50.  *
  51.  */
  52. static const char* const FileDescriptor_hxx_Version = 
  53. "$Id: FileDescriptor.hxx,v 1.2 2001/06/26 22:54:21 icahoon Exp $";
  54. #include "Writer.hxx"
  55. #include "SystemException.hxx"
  56. #include "SystemStatus.hxx"
  57. #include "vtypes.h"
  58. #include <string>
  59. #include <vector>
  60. /** Infrastructure common to VOCAL.
  61.  */
  62. namespace Vocal 
  63. {
  64. /** Infrastructure in VOCAL related to Input/Output.<br><br>
  65.  */
  66. namespace IO
  67. {
  68. /** Type for the native file descriptor, for portability 
  69.  *  and readability.<br><br>
  70.  */
  71. typedef     int     file_descriptor_t;
  72. /** A wrapper class for the operating systems file descriptor.<br><br>
  73.  *  
  74.  *  @see     Vocal::IO::file_descriptor_t
  75.  *  @see     Vocal::IO::Writer
  76.  *  @see     Vocal::SystemException
  77.  */
  78. class FileDescriptor : public Vocal::IO::Writer
  79. {
  80.     public:
  81. /** The value of a file descriptor when it is unusable. This
  82.  *  value may vary across operating systems.
  83.  */
  84.      static const file_descriptor_t     INVALID;
  85. /** The default constructor creates an INVALID file descriptor.
  86.  *  This can also be used to attach to pre-existing file descriptors.
  87.  */
  88.      FileDescriptor(file_descriptor_t = INVALID);
  89. /** The destructor will close() the file descriptor if it is valid.
  90.  *
  91.  *  @exception Vocal::SystemException
  92.  */
  93. virtual ~FileDescriptor();
  94. /** Mutator given a new native file descriptor.
  95.  */
  96.      void setFD(file_descriptor_t);
  97. /** Accessor to native file descriptor.
  98.  */
  99.      file_descriptor_t    getFD() const;
  100. /** When set, this file descriptor will block when used with
  101.  *  a system call that could potentially block, e.g select().
  102.  *
  103.  *  @exception Vocal::SystemException
  104.  */
  105. void setBlocking()
  106.         throw ( Vocal::SystemException );
  107. /** When set, this file descriptor will not block when used with
  108.  *  a system call that could potentially block, e.g select(),
  109.  *  potentially returning a status code like EAGAIN.
  110.  */
  111. void setNonblocking()
  112.          throw ( Vocal::SystemException );
  113.      /** Writes the string to this file descriptor.
  114.  *  <br><br>
  115.       *  
  116.  *  Returns the number of bytes written. If a SystemStatus was 
  117.  *  thrown, the descriptor was set non-blocking and it would 
  118.  *  have blocked (status EAGAIN) or the read was interrupted by 
  119.  *  a signal (status EINTR). On a SystemException the descriptor 
  120.  *  encountered some system error.<br><br>
  121.  *
  122.  *  See write(2).
  123.  */
  124.      int  write(const string &)
  125.     throw ( Vocal::SystemException, Vocal::SystemStatus );
  126.      /** See write(const string &).
  127.  */
  128.      int  write(const char *)
  129.     throw ( Vocal::SystemException, Vocal::SystemStatus );
  130.      /** Binary version of write. See write(const string &).
  131.  */
  132.      int  write(const vector<u_int8_t> &)
  133.     throw ( Vocal::SystemException, Vocal::SystemStatus );
  134.      /** Binary version of write. See write(const string &).
  135.  */
  136.      int  write(const u_int8_t *, size_t)
  137.     throw ( Vocal::SystemException, Vocal::SystemStatus );
  138.      /** This will read a string from the descriptor.
  139.  *  Attempts to read bytes for the descriptor up to the size
  140.  *  of the given string.<br><br>
  141.       *
  142.  *  Returns the number of bytes read, which may be less than the
  143.  *  size of the string. If a SystemStatus was thrown, the 
  144.  *  descriptor was set non-blocking and it would have blocked 
  145.  *  (status EAGAIN) or the read was interrupted by a signal (status
  146.  *  EINTR). On a SystemException the descriptor encountered some 
  147.  *  system error.<br><br>
  148.  *
  149.  *  See read(2).
  150.  */
  151.      int  read(string &)
  152.               throw ( Vocal::SystemException, Vocal::SystemStatus );
  153.      /** Text version of read. See read(string &).
  154.  */
  155.      int  read(char *, size_t)
  156.               throw ( Vocal::SystemException, Vocal::SystemStatus );
  157.      /** Binary version of read See read(string &).
  158.  */
  159.      int  read(vector<u_int8_t> &)
  160.     throw ( Vocal::SystemException, Vocal::SystemStatus );
  161.      /** Binary version of read. See read(string &).
  162.  */
  163.      int  read(u_int8_t *, size_t)
  164.               throw ( Vocal::SystemException, Vocal::SystemStatus );
  165. /** Return the resource back to the operating system. The file 
  166.  *  descriptor is set INVALID.
  167.  */
  168. void close()
  169.          throw ( Vocal::SystemException );
  170. /** Equality relational operator.
  171.  */
  172. bool operator==(const FileDescriptor &) const;
  173. /** Inequality relational operator.
  174.  */
  175. bool operator!=(const FileDescriptor &) const;
  176. /** Less than relational operator.
  177.  */
  178. bool operator<(const FileDescriptor &) const;
  179. /** Less than or equal relational operator.
  180.  */
  181. bool operator<=(const FileDescriptor &) const;
  182. /** Greater than relational operator.
  183.  */
  184. bool operator>(const FileDescriptor &) const;
  185. /** Greater than or equal relational operator.
  186.  */
  187. bool operator>=(const FileDescriptor &) const;
  188. /** Write to an ostream.
  189.  */
  190. virtual ostream &       writeTo(ostream &) const;
  191.     protected:
  192. /** The native file descriptor is available to classes extending
  193.  *  FileDescriptor.
  194.  */
  195.      file_descriptor_t    fd_;
  196.     private:
  197.      int  writeToFD(void *, int length)
  198.               throw ( Vocal::SystemException, Vocal::SystemStatus );
  199.      int  readFromFD(void *, int length)
  200.               throw ( Vocal::SystemException, Vocal::SystemStatus );
  201. /** Copying is suppressed.
  202.  */
  203.      FileDescriptor(const FileDescriptor &);
  204. /** Copying is suppressed.
  205.  */
  206. FileDescriptor &     operator=(const FileDescriptor &);
  207. };
  208. } // namespace Transport
  209. } // namespace Vocal
  210. #endif // !defined(FILEDESCRIPTOR_DOT_H)