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

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(SOCKET_OPTIONS_DOT_H)
  2. #define SOCKET_OPTIONS_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 SocketOptions_hxx_Version = 
  53.     "$Id: SocketOptions.hxx,v 1.7 2001/03/21 03:41:41 icahoon Exp $";
  54. #include "SystemException.hxx"
  55. /** Infrastructure common to VOCAL.
  56.  */
  57. namespace Vocal 
  58. {
  59. /** Infrastructure in VOCAL related to making network transport layer 
  60.  *  connections.<br><br>
  61.  */
  62. namespace Transport 
  63. {
  64. class Socket;
  65. class IPAddress;
  66. /** This class decorates a Socket with the purpose of configuring the 
  67.  *  socket.<br><br>
  68.  *
  69.  *  @see    Vocal::Transport::Socket
  70.  *  @see    Vocal::SystemException
  71.  *  @see    Vocal::Transport::IPAddress
  72.  */
  73. class SocketOptions
  74. {
  75.     public:
  76.      /** Create the SocketOption, decorating the given socket.
  77.  */         
  78.      SocketOptions(Socket &);
  79.      /** destructor
  80.  */         
  81.      ~SocketOptions();
  82.      /** Enable/disable sending of keep-alive messages on 
  83.  *  connection-oriented sockets.
  84.  *
  85.  *  See socket(7), and getsockopt/setsockopt(2).
  86.  */         
  87.      void      keepAlive(bool on) 
  88.          throw ( Vocal::SystemException );
  89.      /** Query state of keepAlive.
  90.  */         
  91. bool      keepAlive() const
  92.          throw ( Vocal::SystemException );
  93.      /** Enable BSD bug-to-bug compatibility. Linux only.
  94.  *
  95.  *  See socket(7), and getsockopt/setsockopt(2).
  96.  */         
  97. void      bsdCompatible(bool on)
  98.          throw ( Vocal::SystemException );
  99.      /** Query state of bsdCompatibility.
  100.  */         
  101. bool      bsdCompatible() const
  102.          throw ( Vocal::SystemException );
  103.      /** Indicates that the rules used in validating addresses supplied  
  104.  *  in a bind(2) call should allow reuse of local addresses.
  105.  *
  106.  *  See socket(7), and getsockopt/setsockopt(2).
  107.  */         
  108. void      reuseAddress(bool on)
  109.          throw ( Vocal::SystemException );
  110.      /** Query state of reuseAddress.
  111.  */         
  112. bool      reuseAddress() const     
  113.          throw ( Vocal::SystemException );
  114.      /** When enabled, datagram sockets receive packets sent to a broadcast
  115.       *  address and they are allowed to send packets to a broadcast 
  116.  *  address. This option has no effect on stream-oriented sockets.
  117.  *
  118.  *  See socket(7), and getsockopt/setsockopt(2).
  119.  */         
  120. void      broadcast(bool on)
  121.          throw ( Vocal::SystemException );
  122.      /** Query state of broadcast.
  123.  */         
  124. bool      broadcast() const
  125.          throw ( Vocal::SystemException );
  126.      /** When enabled, a close(2) or shutdown(2) will not return until all 
  127.  *  queued messages for the socket have been successfully sent or the 
  128.  *  linger timeout has been reached. Otherwise, the call returns 
  129.  *  immediately and the closing is done in the background.
  130.  *
  131.  *  See socket(7), and getsockopt/setsockopt(2).
  132.  */         
  133. void      linger(bool on, int seconds)
  134.          throw ( Vocal::SystemException );
  135.      /** Query state of linger. If enabled, the seconds will return
  136.  *  with the linger timeout.
  137.  */         
  138. bool      linger(int & seconds) const
  139.          throw ( Vocal::SystemException );
  140.      /** Join a multicast group, as given in the IPAddress.
  141.  *
  142.  *  See ip(7), and getsockopt/setsockopt(2).
  143.  */         
  144. void      joinMulticastGroup(IPAddress & mcastAddr)
  145.          throw ( Vocal::SystemException );
  146.      /** Leave a multicast group, as given in the IPAddress.
  147.  *
  148.  *  See ip(7), and getsockopt/setsockopt(2).
  149.  */         
  150. void      leaveMulticastGroup(IPAddress & mcastAddr)
  151.          throw ( Vocal::SystemException );
  152.     private:
  153.      void      set(int level, int optname, bool)
  154.          throw ( Vocal::SystemException );
  155. bool      get(int level, int optname) const
  156.          throw ( Vocal::SystemException );
  157.     
  158.      mutable Socket     & socket_;
  159. };
  160. } // namespace Transport
  161. } // namespace Vocal
  162. #endif // !defined(SOCKET_OPTIONS_DOT_H)