rbb 99/04/13 04:53:22
Modified: docs networkio.txt
Log:
Update to network API documentation
Revision Changes Path
1.2 +38 -11 apache-apr/docs/networkio.txt
Index: networkio.txt
===================================================================
RCS file: /home/cvs/apache-apr/docs/networkio.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- networkio.txt 1999/04/12 18:23:12 1.1
+++ networkio.txt 1999/04/13 11:53:21 1.2
@@ -1,5 +1,33 @@
<h2> Network I/O</h2>
+ apr_socket_t *apr_create_tcp_socket(void)
+ Create a new TCP network connection
+ Arguments:
+ return) Abstracted out ptr to file descriptor, pointing to
+ the created Socket. NULL on failure.
+
+ apr_status_t apr_shutdown(apr_socket_t *, apr_shutdown_how)
+ shuts down part of a full-duplex connection on a specified socket
+ Arguments:
+ arg 1) File descriptor of socket
+ arg 2) How to shutdown the socket.
+ One of:
+ APR_SHUTDOWN_READ
+ APR_SHUTDOWN_WRITE
+ APR_SHUTDOWN_READWRITE
+ return) APR_SUCCESS or APR_FAILURE
+Note: This does not free the memory consumed by apr_socket, apr_clsoe will
take
+ care of that.
+
+ apr_status_t apr_close_socket(apr_socket_t *)
+ closes the socket descriptor
+ Arguments:
+ arg 1) The socket to close
+ return) APR_SUCCESS or APR_FAILURE
+Note: If closing the socket fails, I am leaving the structure in tact, in
the
+ hopes that we may be able to close it later. If we free all the
memory
+ used, we can't even try to recover.
+
APRStatus apr_send(APRSocket, const void *, APRUInt64, APRUInt64 *)
Sends a message over a socket
Arguments:
@@ -19,11 +47,6 @@
out
-->
arg 4) Amount of data received in bytes
- APRStatus apr_create_tcp_socket(APSocket *)
- Create a new TCP network connection
- Arguments:
- arg 1) Abstracted out ptr to file descriptor, pointing to
- the created Socket. NULL on failure.
APRStatus apr_initializenetaddr(APRNetAddrValue, APRUInt16, APRNetAddr);
Initialize the fields of a APRNetAddr. assigning well known values
as appropriate. This function only sets up values in the APRNetAddr
@@ -77,7 +100,7 @@
16 bit conversion from network to host byte order
Arguments:
arg 1) the integer to convert
- arg 2) the integer in proper byte order.
+ arg 2) te integer in proper byte order.
APRStatus apr_netaddrtostring(const APRNetAddr *, char *, APRUInt32)
Convert an internet address to a String
Arguments:
@@ -132,8 +155,12 @@
Arguments:
arg 1) The file desc of the socket to retrieve the name for.
arg 2) structure to store socket address in.
- APRStatus apr_shutdown(APRSocket, APRShutdownHow)
- shuts down part of a full-duplex connection on a specified socket
- Arguments:
- arg 1) File descriptor of socket
- arg 2) How to shutdown the socket.
+
+**************** IMPLEMENTATION DETAILS *****************
+
+struct apr_socket_t {
+ int socketdes
+ char *hostname
+}
+
+
