stas 2004/08/17 18:39:33
Modified: src/docs/2.0/api/APR Socket.pod
Log:
polish
Revision Changes Path
1.12 +43 -34 modperl-docs/src/docs/2.0/api/APR/Socket.pod
Index: Socket.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/APR/Socket.pod,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -u -r1.11 -r1.12
--- Socket.pod 10 Jul 2004 00:26:55 -0000 1.11
+++ Socket.pod 18 Aug 2004 01:39:32 -0000 1.12
@@ -109,7 +109,7 @@
=over 4
=item obj: C<$sock>
-( C<L<APR::Socket|docs::2.0::api::APR::Socket>> object )
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> object )
the socket object to set up.
@@ -151,7 +151,7 @@
=over 4
=item obj: C<$sock>
-( C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>> object )
+( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> object )
The socket to read from
@@ -226,7 +226,8 @@
=over 4
-=item obj: C<$sock> ( C<L<APR::Socket|docs::2.0::api::APR::Socket>> )
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The socket to write to
@@ -267,7 +268,8 @@
=over 4
-=item obj: C<$sock> ( C<L<APR::Socket|docs::2.0::api::APR::Socket>> )
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The socket to set up.
@@ -308,7 +310,8 @@
=over 4
-=item obj: C<$sock> ( C<L<APR::Socket|docs::2.0::api::APR::Socket>> )
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The socket to set up.
@@ -393,15 +396,17 @@
=over 4
-=item obj: C<$sock> (C<L<APR::Socket|docs::2.0::api::APR::Socket>>)
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The socket to bind
-=item arg1: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>)
+=item arg1: C<$sa>
+( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
The socket address to bind to
-=item ret: C<$ret> (integer)
+=item ret: C<$ret> ( integer )
=item since: subject to change
@@ -421,15 +426,16 @@
Close a socket.
- $ret = $thesocket->close();
+ $ret = $sock->close();
=over 4
-=item obj: C<$thesocket> (C<L<APR::Socket|docs::2.0::api::APR::Socket>>)
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The socket to close
-=item ret: C<$ret> (integer)
+=item ret: C<$ret> ( integer )
=item since: subject to change
@@ -452,17 +458,19 @@
=over 4
-=item obj: C<$sock> (C<L<APR::Socket|docs::2.0::api::APR::Socket>>)
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The socket we wish to use for our side of the connection
-=item arg1: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAdrr>>)
+=item arg1: C<$sa>
+( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAdrr>> )
The address of the machine we wish to connect to. If NULL,
APR assumes that the sockaddr_in in the apr_socket is
completely filled out.
-=item ret: C<$ret> (integer)
+=item ret: C<$ret> ( integer )
=item since: subject to change
@@ -483,17 +491,18 @@
=over 4
-=item obj: C<$sock> (C<L<APR::Socket|docs::2.0::api::APR::Socket>>)
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
-The socket to listen on
+The socket to listen on
-=item arg1: C<$backlog> (integer)
+=item arg1: C<$backlog> ( integer )
The number of outstanding connections allowed in the sockets
listen queue. If this value is less than zero, the listen
queue size is set to zero.
-=item ret: C<$ret> (integer)
+=item ret: C<$ret> ( integer )
=item since: subject to change
@@ -513,33 +522,33 @@
META: Autogenerated - needs to be reviewed/completed
-
-
$ret = $from->recvfrom($sock, $flags, $buf, $len);
=over 4
-=item obj: C<$from> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>)
+=item obj: C<$from>
+( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
The apr_sockaddr_t to fill in the recipient info
-=item arg1: C<$sock> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>)
+=item arg1: C<$sock>
+( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
The socket to use
-=item arg2: C<$flags> (integer)
+=item arg2: C<$flags> ( integer )
The flags to use
-=item arg3: C<$buf> (integer)
+=item arg3: C<$buf> ( integer )
The buffer to use
-=item arg4: C<$len> (string)
+=item arg4: C<$len> ( string )
The length of the available buffer
-=item ret: C<$ret> (integer)
+=item ret: C<$ret> ( integer )
=item since: subject to change
@@ -554,33 +563,33 @@
META: Autogenerated - needs to be reviewed/completed
-
-
$ret = $sock->sendto($where, $flags, $buf, $len);
=over 4
-=item obj: C<$sock> (C<L<APR::Socket|docs::2.0::api::APR::Socket>>)
+=item obj: C<$sock>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The socket to send from
-=item arg1: C<$where> (C<L<APR::Socket|docs::2.0::api::APR::Socket>>)
+=item arg1: C<$where>
+( C<L<APR::Socket object|docs::2.0::api::APR::Socket>> )
The apr_sockaddr_t describing where to send the data
-=item arg2: C<$flags> (integer)
+=item arg2: C<$flags> ( integer )
The flags to use
-=item arg3: C<$buf> (scalar)
+=item arg3: C<$buf> ( scalar )
The data to send
-=item arg4: C<$len> (string)
+=item arg4: C<$len> ( string )
The length of the data to send
-=item ret: C<$ret> (integer)
+=item ret: C<$ret> ( integer )
=item since: subject to change
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
