Hide apr_wait_for_io_or_timeout() from public view and add instead

apr_socket_wait() and apr_file_pipe_wait().


git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@933338 13f79535-47bb-0310-9956-ffa450edef68

Author: Brian Havard

CHANGES

@@ -1,6 +1,9 @@
                                                      -*- coding: utf-8 -*-
 Changes for APR 2.0.0
 
+  *) Hide apr_wait_for_io_or_timeout() from public view and add instead
+     apr_socket_wait() and apr_file_pipe_wait(). [Brian Havard]
+
   *) Add apr_hash_this_key(), apr_hash_this_key_len(), and 
      apr_hash_this_val() for easier access to those attributes from
      a hash iterator.  [Hyrum K. Wright <hyrum_wright mail.utexas.edu>]

file_io/os2/pipe.c

@@ -81,7 +81,7 @@ APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, apr_file_t **out
     (*in)->fname = apr_pstrdup(pool, pipename);
     (*in)->isopen = TRUE;
     (*in)->buffered = FALSE;
-    (*in)->flags = 0;
+    (*in)->flags = APR_FOPEN_READ;
     (*in)->pipe = 1;
     (*in)->timeout = -1;
     (*in)->blocking = BLK_ON;
@@ -113,7 +113,7 @@ APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, apr_file_t **out
     (*out)->fname = apr_pstrdup(pool, pipename);
     (*out)->isopen = TRUE;
     (*out)->buffered = FALSE;
-    (*out)->flags = 0;
+    (*out)->flags = APR_FOPEN_WRITE;
     (*out)->pipe = 1;
     (*out)->timeout = -1;
     (*out)->blocking = BLK_ON;

file_io/os2/readwrite.c

@@ -409,6 +409,31 @@ apr_status_t apr_file_check_read(apr_file_t *fd)
 
 
 
+APR_DECLARE(apr_status_t) apr_file_pipe_wait(apr_file_t *pipe, apr_wait_type_t direction)
+{
+    int rc;
+
+    if (!pipe->pipe) {
+        /* No support for waiting on a regular file */
+        return APR_ENOTIMPL;
+    }
+
+    if (((pipe->flags & APR_FOPEN_READ) > 0) != (direction == APR_WAIT_READ)) {
+        /* Attempt to wait for read from the write end of the pipe or vica versa */
+        return APR_EINVAL;
+    }
+
+    rc = DosWaitEventSem(pipe->pipeSem, pipe->timeout >= 0 ? pipe->timeout / 1000 : SEM_INDEFINITE_WAIT);
+
+    if (rc == ERROR_TIMEOUT) {
+        return APR_TIMEUP;
+    }
+
+    return APR_FROM_OS_ERROR(rc);
+}
+
+
+
 APR_DECLARE(apr_status_t) apr_file_rotating_check(apr_file_t *thefile)
 {
     return APR_ENOTIMPL;

file_io/unix/readwrite.c

@@ -562,3 +562,10 @@ APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, apr_file_t *thefile)
     }
     return rv;
 }
+
+
+
+APR_DECLARE(apr_status_t) apr_file_pipe_wait(apr_file_t *thepipe, apr_wait_type_t direction)
+{
+    return apr_wait_for_io_or_timeout(thepipe, NULL, direction == APR_WAIT_READ);
+}

include/apr_file_io.h

@@ -568,6 +568,16 @@ APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len,
  */
 APR_DECLARE(apr_status_t) apr_file_puts(const char *str, apr_file_t *thefile);
 
+/**
+ * Wait for a pipe to be ready for input or output
+ * @param thepipe the pipe to wait on
+ * @param direction whether to wait for reading or writing to be ready
+ *        Can be either APR_WAIT_READ or APR_WAIT_WRITE
+ * @remark Will time out if thepipe has a time out set for it
+ */
+APR_DECLARE(apr_status_t) apr_file_pipe_wait(apr_file_t *thepipe,
+                                             apr_wait_type_t direction);
+
 /**
  * Flush the file's buffer.
  * @param thefile The file descriptor to flush

include/apr_general.h

@@ -67,6 +67,9 @@ extern "C" {
 /** signal numbers typedef */
 typedef int               apr_signum_t;
 
+/* Type of I/O to wait for */
+typedef enum { APR_WAIT_READ, APR_WAIT_WRITE } apr_wait_type_t;
+
 /**
  * Finding offsets of elements within structures.
  * Taken from the X code... they've sweated portability of this stuff

include/apr_network_io.h

@@ -620,6 +620,16 @@ APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock,
 APR_DECLARE(apr_status_t) apr_socket_recv(apr_socket_t *sock, 
                                    char *buf, apr_size_t *len);
 
+/**
+ * Wait for a socket to be ready for input or output
+ * @param sock the socket to wait on
+ * @param direction whether to wait for reading or writing to be ready
+ * @remark Will time out if socket has a time out set for it
+ * @remark direction can be either APR_WAIT_READ or APR_WAIT_WRITE
+ */
+APR_DECLARE(apr_status_t) apr_socket_wait(apr_socket_t *sock, 
+                                          apr_wait_type_t direction);
+
 /**
  * Setup socket options for the specified socket
  * @param sock The socket to set up.

include/apr_support.h include/private/apr_support.hinclude/apr_support.h renamed to include/private/apr_support.h

@@ -153,3 +153,21 @@ APR_DECLARE(apr_status_t) apr_socket_sendv(apr_socket_t *sock,
     *len = rv;
     return APR_SUCCESS;
 }
+
+
+
+APR_DECLARE(apr_status_t) apr_socket_wait(apr_socket_t *sock, apr_wait_type_t direction)
+{
+    int pollsocket = sock->socketdes;
+    int wait_rc = select(&pollsocket, direction == APR_WAIT_READ, 
+                         direction == APR_WAIT_WRITE, 0, sock->timeout / 1000);
+
+    if (wait_rc == 0) {
+        return APR_TIMEUP;
+    }
+    else if (wait_rc < 0) {
+        return APR_FROM_OS_ERROR(sock_errno());
+    }
+
+    return APR_SUCCESS;
+}

network_io/os2/sendrecv.c

@@ -235,6 +235,11 @@ apr_status_t apr_socket_sendv(apr_socket_t * sock, const struct iovec *vec,
 #endif
 }
 
+apr_status_t apr_socket_wait(apr_socket_t *sock, apr_wait_type_t direction)
+{
+    return apr_wait_for_io_or_timeout(NULL, sock, direction == APR_WAIT_READ);
+}
+
 #if APR_HAS_SENDFILE
 
 /* TODO: Verify that all platforms handle the fd the same way,