tcpsock.h
上传用户:hzhsqp
上传日期:2007-01-06
资源大小:1600k
文件大小:10k
源码类别:

IP电话/视频会议

开发平台:

Visual C++

  1. /*
  2.  * tcpsock.h
  3.  *
  4.  * Transmission Control Protocol socket channel class.
  5.  *
  6.  * Portable Windows Library
  7.  *
  8.  * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
  9.  *
  10.  * The contents of this file are subject to the Mozilla Public License
  11.  * Version 1.0 (the "License"); you may not use this file except in
  12.  * compliance with the License. You may obtain a copy of the License at
  13.  * http://www.mozilla.org/MPL/
  14.  *
  15.  * Software distributed under the License is distributed on an "AS IS"
  16.  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17.  * the License for the specific language governing rights and limitations
  18.  * under the License.
  19.  *
  20.  * The Original Code is Portable Windows Library.
  21.  *
  22.  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  23.  *
  24.  * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
  25.  * All Rights Reserved.
  26.  *
  27.  * Contributor(s): ______________________________________.
  28.  *
  29.  * $Log: tcpsock.h,v $
  30.  * Revision 1.25  1999/09/28 00:08:59  robertj
  31.  * Fixed some comment typoes
  32.  *
  33.  * Revision 1.24  1999/09/28 00:07:54  robertj
  34.  * Fixed some comment typoes
  35.  *
  36.  * Revision 1.23  1999/08/30 02:21:03  robertj
  37.  * Added ability to listen to specific interfaces for IP sockets.
  38.  *
  39.  * Revision 1.22  1999/03/09 02:59:51  robertj
  40.  * Changed comments to doc++ compatible documentation.
  41.  *
  42.  * Revision 1.21  1999/02/16 08:11:17  robertj
  43.  * MSVC 6.0 compatibility changes.
  44.  *
  45.  * Revision 1.20  1998/12/22 10:23:08  robertj
  46.  * Added clone() function to support SOCKS in FTP style protocols.
  47.  *
  48.  * Revision 1.19  1998/09/23 06:21:37  robertj
  49.  * Added open source copyright license.
  50.  *
  51.  * Revision 1.18  1998/08/21 05:24:46  robertj
  52.  * Fixed bug where write streams out to non-stream socket.
  53.  *
  54.  * Revision 1.17  1996/09/14 13:09:42  robertj
  55.  * Major upgrade:
  56.  *   rearranged sockets to help support IPX.
  57.  *   added indirect channel class and moved all protocols to descend from it,
  58.  *   separating the protocol from the low level byte transport.
  59.  *
  60.  * Revision 1.16  1996/03/26 00:57:15  robertj
  61.  * Added contructor that takes PTCPSocket so avoid copy constructor being used instead of accept.
  62.  *
  63.  * Revision 1.15  1996/03/03 07:37:59  robertj
  64.  * Added Reusability clause to the Listen() function on sockets.
  65.  *
  66.  * Revision 1.14  1996/02/25 03:01:27  robertj
  67.  * Moved some socket functions to platform dependent code.
  68.  *
  69.  * Revision 1.13  1995/12/10 11:43:34  robertj
  70.  * Numerous fixes for sockets.
  71.  *
  72.  * Revision 1.12  1995/06/17 11:13:31  robertj
  73.  * Documentation update.
  74.  *
  75.  * Revision 1.11  1995/06/17 00:47:31  robertj
  76.  * Changed overloaded Open() calls to 3 separate function names.
  77.  * More logical design of port numbers and service names.
  78.  *
  79.  * Revision 1.10  1995/06/04 12:46:25  robertj
  80.  * Slight redesign of port numbers on sockets.
  81.  *
  82.  * Revision 1.9  1995/03/14 12:42:46  robertj
  83.  * Updated documentation to use HTML codes.
  84.  *
  85.  * Revision 1.8  1995/03/12  04:46:40  robertj
  86.  * Added more functionality.
  87.  *
  88.  * Revision 1.7  1995/01/03  09:36:22  robertj
  89.  * Documentation.
  90.  *
  91.  * Revision 1.6  1995/01/01  01:07:33  robertj
  92.  * More implementation.
  93.  *
  94.  * Revision 1.5  1994/08/23  11:32:52  robertj
  95.  * Oops
  96.  *
  97.  * Revision 1.4  1994/08/22  00:46:48  robertj
  98.  * Added pragma fro GNU C++ compiler.
  99.  *
  100.  * Revision 1.3  1994/08/21  23:43:02  robertj
  101.  * Changed type of socket port number for better portability.
  102.  * Added Out of Band data functions.
  103.  *
  104.  * Revision 1.2  1994/07/25  03:36:03  robertj
  105.  * Added sockets to common, normalising to same comment standard.
  106.  *
  107.  */
  108. #define _PTCPSOCKET
  109. #ifdef __GNUC__
  110. #pragma interface
  111. #endif
  112. /** A socket that uses the TCP transport on the Internet Protocol.
  113.  */
  114. class PTCPSocket : public PIPSocket
  115. {
  116.   PCLASSINFO(PTCPSocket, PIPSocket);
  117.   public:
  118.   /**@name Construction. */
  119.   //@{
  120.     /**Create a TCP/IP protocol socket channel. If a remote machine address or
  121.        a "listening" socket is specified then the channel is also opened.
  122.        Note that what looks like a "copy" constructor here is really a
  123.        the accept of a "listening" socket the same as the PSocket & parameter
  124.        version constructor.
  125.      */
  126.     PTCPSocket(
  127.       WORD port = 0             /// Port number to use for the connection.
  128.     );
  129.     PTCPSocket(
  130.       const PString & service   /// Service name to use for the connection.
  131.     );
  132.     PTCPSocket(
  133.       const PString & address,  /// Address of remote machine to connect to.
  134.       WORD port                 /// Port number to use for the connection.
  135.     );
  136.     PTCPSocket(
  137.       const PString & address,  /// Address of remote machine to connect to.
  138.       const PString & service   /// Service name to use for the connection.
  139.     );
  140.     PTCPSocket(
  141.       PSocket & socket          /// Listening socket making the connection.
  142.     );
  143.     PTCPSocket(
  144.       PTCPSocket & tcpSocket    /// Listening socket making the connection.
  145.     );
  146.   //@}
  147.   /**@name Overrides from class PObject. */
  148.   //@{
  149.     /** Create a copy of the class on the heap. The exact semantics of the
  150.        descendent class determine what is required to make a duplicate of the
  151.        instance. Not all classes can even {bf do} a clone operation.
  152.        
  153.        The main user of the clone function is the #PDictionary# class as
  154.        it requires copies of the dictionary keys.
  155.        The default behaviour is for this function to assert.
  156.        @return
  157.        pointer to new copy of the class instance.
  158.      */
  159.     virtual PObject * Clone() const;
  160.   //@}
  161.   /**@name Overrides from class PChannel. */
  162.   //@{
  163.     /** Low level write to the channel. This function will block until the
  164.        requested number of characters are written or the write timeout is
  165.        reached. The GetLastWriteCount() function returns the actual number
  166.        of bytes written.
  167.        The GetErrorCode() function should be consulted after Write() returns
  168.        FALSE to determine what caused the failure.
  169.        This override repeatedly writes if there is no error until all of the
  170.        requested bytes have been written.
  171.        @return
  172.        TRUE if at least len bytes were written to the channel.
  173.      */
  174.     virtual BOOL Write(
  175.       const void * buf, /// Pointer to a block of memory to write.
  176.       PINDEX len        /// Number of bytes to write.
  177.     );
  178.   //@}
  179.   /**@name Overrides from class PSocket. */
  180.   //@{
  181.     /** Listen on a socket for a remote host on the specified port number. This
  182.        may be used for server based applications. A "connecting" socket begins
  183.        a connection by initiating a connection to this socket. An active socket
  184.        of this type is then used to generate other "accepting" sockets which
  185.        establish a two way communications channel with the "connecting" socket.
  186.        If the #port# parameter is zero then the port number as
  187.        defined by the object instance construction or the
  188.        #PIPSocket::SetPort()# function.
  189.        @return
  190.        TRUE if the channel was successfully opened.
  191.      */
  192.     virtual BOOL Listen(
  193.       unsigned queueSize = 5,  /// Number of pending accepts that may be queued.
  194.       WORD port = 0,           /// Port number to use for the connection.
  195.       Reusability reuse = AddressIsExclusive /// Can/Can't listen more than once.
  196.     );
  197.     virtual BOOL Listen(
  198.       const Address & bind,     /// Local interface address to bind to.
  199.       unsigned queueSize = 5,   /// Number of pending accepts that may be queued.
  200.       WORD port = 0,            /// Port number to use for the connection.
  201.       Reusability reuse = AddressIsExclusive /// Can/Can't listen more than once.
  202.     );
  203.     /** Open a socket to a remote host on the specified port number. This is an
  204.        "accepting" socket. When a "listening" socket has a pending connection
  205.        to make, this will accept a connection made by the "connecting" socket
  206.        created to establish a link.
  207.        The port that the socket uses is the one used in the #Listen()#
  208.        command of the #socket# parameter.
  209.        Note that this function will block until a remote system connects to the
  210.        port number specified in the "listening" socket.
  211.        @return
  212.        TRUE if the channel was successfully opened.
  213.      */
  214.     virtual BOOL Accept(
  215.       PSocket & socket          /// Listening socket making the connection.
  216.     );
  217.   //@}
  218.   /**@name New functions for class. */
  219.   //@{
  220.     /** Write out of band data from the TCP/IP stream. This data is sent as TCP
  221.        URGENT data which does not follow the usual stream sequencing of the
  222.        normal channel data.
  223.        This is subject to the write timeout and sets the
  224.        #lastWriteCount# member variable in the same way as usual
  225.        #PChannel::Write()# function.
  226.        
  227.        @return
  228.        TRUE if all the bytes were sucessfully written.
  229.      */
  230.     virtual BOOL WriteOutOfBand(
  231.       const void * buf,   /// Data to be written as URGENT TCP data.
  232.       PINDEX len          /// Number of bytes pointed to by #buf#.
  233.     );
  234.     /** This is callback function called by the system whenever out of band data
  235.        from the TCP/IP stream is received. A descendent class may interpret
  236.        this data according to the semantics of the high level protocol.
  237.        The default behaviour is for the out of band data to be ignored.
  238.      */
  239.     virtual void OnOutOfBand(
  240.       const void * buf,   /// Data to be received as URGENT TCP data.
  241.       PINDEX len          /// Number of bytes pointed to by #buf#.
  242.     );
  243.   //@}
  244.   protected:
  245.     virtual BOOL OpenSocket();
  246.     virtual const char * GetProtocolName() const;
  247. #ifdef DOC_PLUS_PLUS
  248. };
  249. #endif
  250. // Class declaration continued in platform specific header file ///////////////