stas 2004/01/14 17:08:49 Modified: src/docs/2.0/api/Apache Connection.pod Log: sort methods Revision Changes Path 1.2 +92 -86 modperl-docs/src/docs/2.0/api/Apache/Connection.pod Index: Connection.pod =================================================================== RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Connection.pod,v retrieving revision 1.1 retrieving revision 1.2 diff -u -u -r1.1 -r1.2 --- Connection.pod 14 Jan 2004 09:23:47 -0000 1.1 +++ Connection.pod 15 Jan 2004 01:08:49 -0000 1.2 @@ -28,17 +28,20 @@ -=head2 C<pool> -Pool associated with this connection +=head2 C<aborted> - $p = $c->pool(); +Check whether the connection is still open + + $status = $c->aborted(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>) +=item ret: C<$status> (number) + +true if the connection has been aborted, false if still open =back @@ -46,6 +49,7 @@ + =head2 C<base_server> Physical vhost this connection came in on @@ -64,17 +68,19 @@ -=head2 C<local_addr> +=head2 C<bucket_alloc> -Get this connection's local socket address +META: Autogenerated - needs to be reviewed/completed - $sa = $c->local_addr(); +The bucket allocator to use for all bucket/brigade creations + + $ba = $c->bucket_alloc(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>) +=item ret: C<$ba> (C<L<APR::BucketAlloc|docs::2.0::api::APR::BucketAlloc>>) =back @@ -82,17 +88,19 @@ -=head2 C<remote_addr> +=head2 C<conn_config> -Get this connection's remote socket address +META: Autogenerated - needs to be reviewed/completed - $sa = $c->remote_addr(); +Notes on *this* connection + + $ret = $c->conn_config(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>) +=item ret: C<$ret> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) =back @@ -100,17 +108,19 @@ -=head2 C<remote_ip> -Client's IP address - $remote_ip = $c->remote_ip(); +=head2 C<id> + +ID of this connection; unique at any point in time + + $id = $c->id(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$remote_ip> (string) +=item ret: C<$id> (integer) =back @@ -118,19 +128,19 @@ -=head2 C<remote_host> +=head2 C<input_filters> -Client's DNS name, if known. NULL if DNS hasn't been checked, "" if -it has and no address was found. N.B. Only access this though -get_remote_host() +A list of input filters to be used for this connection - $remote_host = $c->remote_host(); + $input_filters = $c->input_filters(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$remote_host> (string) +=item ret: C<$input_filters> (C<L<Apache::Filter|docs::2.0::api::Apache::Filter>>) + +The first filter in the connection input filters chain. =back @@ -138,18 +148,17 @@ -=head2 C<remote_logname> +=head2 C<keepalive> -Only ever set if doing rfc1413 lookups. N.B. Only access this through -get_remote_logname() +Are we going to keep the connection alive for another request? - $remote_logname = $c->remote_logname(); + $status = $c->keepalive(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$remote_logname> (string) +=item ret: C<$status> (integer) =back @@ -157,19 +166,17 @@ -=head2 C<aborted> +=head2 C<local_addr> -Check whether the connection is still open +Get this connection's local socket address - $status = $c->aborted(); + $sa = $c->local_addr(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$status> (number) - -true if the connection has been aborted, false if still open +=item ret: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>) =back @@ -177,17 +184,18 @@ -=head2 C<keepalive> +=head2 C<local_host> -Are we going to keep the connection alive for another request? +used for ap_get_server_name when UseCanonicalName is set to DNS +(ignores setting of HostnameLookups) - $status = $c->keepalive(); + $local_host = $c->local_host(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$status> (integer) +=item ret: C<$local_host> (string) =back @@ -195,6 +203,8 @@ + + =head2 C<local_ip> server IP address @@ -212,19 +222,23 @@ +=head2 C<notes> -=head2 C<local_host> +META: Autogenerated - needs to be reviewed/completed -used for ap_get_server_name when UseCanonicalName is set to DNS -(ignores setting of HostnameLookups) +send note from one module to another, must remain valid for all +requests on this conn - $local_host = $c->local_host(); + $c->notes($notes); + $notes = $c->notes(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$local_host> (string) +=item arg2: C<$notes> (C<L<APR::Table|docs::2.0::api::APR::Table>>) + +=item ret: =back @@ -232,37 +246,38 @@ -=head2 C<id> +=head2 C<output_filters> -ID of this connection; unique at any point in time +META: Autogenerated - needs to be reviewed/completed - $id = $c->id(); +A list of output filters to be used for this connection + + $output_filters = $c->output_filters(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$id> (integer) +=item ret: C<$output_filters> (C<L<Apache::Filter|docs::2.0::api::Apache::Filter>>) -=back +The first filter in the connection output filters chain. +=back -=head2 C<conn_config> - -META: Autogenerated - needs to be reviewed/completed +=head2 C<pool> -Notes on *this* connection +Pool associated with this connection - $ret = $c->conn_config(); + $p = $c->pool(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$ret> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>) +=item ret: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>) =back @@ -270,23 +285,19 @@ -=head2 C<notes> -META: Autogenerated - needs to be reviewed/completed -send note from one module to another, must remain valid for all -requests on this conn +=head2 C<remote_addr> - $c->notes($notes); - $notes = $c->notes(); +Get this connection's remote socket address + + $sa = $c->remote_addr(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item arg2: C<$notes> (C<L<APR::Table|docs::2.0::api::APR::Table>>) - -=item ret: +=item ret: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>) =back @@ -294,19 +305,17 @@ -=head2 C<input_filters> +=head2 C<remote_ip> -A list of input filters to be used for this connection +Client's IP address - $input_filters = $c->input_filters(); + $remote_ip = $c->remote_ip(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$input_filters> (C<L<Apache::Filter|docs::2.0::api::Apache::Filter>>) - -The first filter in the connection input filters chain. +=item ret: C<$remote_ip> (string) =back @@ -314,21 +323,19 @@ -=head2 C<output_filters> - -META: Autogenerated - needs to be reviewed/completed +=head2 C<remote_host> -A list of output filters to be used for this connection +Client's DNS name, if known. NULL if DNS hasn't been checked, "" if +it has and no address was found. N.B. Only access this though +get_remote_host() - $output_filters = $c->output_filters(); + $remote_host = $c->remote_host(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$output_filters> (C<L<Apache::Filter|docs::2.0::api::Apache::Filter>>) - -The first filter in the connection output filters chain. +=item ret: C<$remote_host> (string) =back @@ -336,19 +343,18 @@ -=head2 C<sbh> - -META: Autogenerated - needs to be reviewed/completed +=head2 C<remote_logname> -handle to scoreboard information for this connection +Only ever set if doing rfc1413 lookups. N.B. Only access this through +get_remote_logname() - $sbh = $c->sbh(); + $remote_logname = $c->remote_logname(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$sbh> (XXX) +=item ret: C<$remote_logname> (string) =back @@ -356,19 +362,19 @@ -=head2 C<bucket_alloc> +=head2 C<sbh> META: Autogenerated - needs to be reviewed/completed -The bucket allocator to use for all bucket/brigade creations +handle to scoreboard information for this connection - $ba = $c->bucket_alloc(); + $sbh = $c->sbh(); =over 4 =item arg1: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>) -=item ret: C<$ba> (C<L<APR::BucketAlloc|docs::2.0::api::APR::BucketAlloc>>) +=item ret: C<$sbh> (XXX) =back
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
