cvs commit: apr/include apr_network_io.h

[trawick]

trawick     2003/05/29 19:26:31

  Modified:    include  apr_network_io.h
  Log:
  describe the timeout parameter to apr_socket_timeout_set()
  
  Revision  Changes    Path
  1.141     +6 -0      apr/include/apr_network_io.h
  
  Index: apr_network_io.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_network_io.h,v
  retrieving revision 1.140
  retrieving revision 1.141
  diff -u -r1.140 -r1.141
  --- apr_network_io.h  5 Mar 2003 21:22:26 -0000       1.140
  +++ apr_network_io.h  30 May 2003 02:26:31 -0000      1.141
  @@ -676,6 +676,12 @@
    * Setup socket timeout for the specified socket
    * @param sock The socket to set up.
    * @param t Value for the timeout.
  + * <PRE>
  + *   t > 0  -- read and write calls return APR_TIMEUP if specified time
  + *             elapsess with no data read or written
  + *   t == 0 -- read and write calls never block
  + *   t < 0  -- read and write calls block
  + * </PRE>
    */
   APR_DECLARE(apr_status_t) apr_socket_timeout_set(apr_socket_t *sock,
                                                    apr_interval_time_t t);