perl-docs-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject cvs commit: modperl-docs/src/docs/2.0/api/Apache Connection.pod RequestRec.pod
Date Sat, 24 Jul 2004 09:27:37 GMT
stas        2004/07/24 02:27:37

  Modified:    src/docs/2.0/api/Apache Connection.pod RequestRec.pod
  Log:
  more docs
  
  Revision  Changes    Path
  1.8       +104 -26   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.7
  retrieving revision 1.8
  diff -u -u -r1.7 -r1.8
  --- Connection.pod	12 Jul 2004 23:13:22 -0000	1.7
  +++ Connection.pod	24 Jul 2004 09:27:37 -0000	1.8
  @@ -37,12 +37,15 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$status> (number)
   
   true if the connection has been aborted, false if still open
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -58,10 +61,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$base_server> (C<L<Apache::Server|docs::2.0::api::Apache::ServerRec>>)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -78,10 +84,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$ba> (C<L<APR::BucketAlloc|docs::2.0::api::APR::BucketAlloc>>)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -98,10 +107,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$ret> (C<L<Apache::ConfVector|docs::2.0::api::Apache::ConfVector>>)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -118,10 +130,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$id> (integer)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -130,20 +145,36 @@
   
   =head2 C<input_filters>
   
  -A list of input filters to be used for this connection
  +Get/set the first filter in a linked list of protocol level input
  +filters:
   
  -  $input_filters = $c->input_filters();
  +  $input_filters      = $r->input_filters();
  +  $prev_input_filters = $r->input_filters($new_input_filters);
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
  +
  +=item opt arg1: C<$new_input_filters>
   
  -=item ret: C<$input_filters> (C<L<Apache::Filter|docs::2.0::api::Apache::Filter>>)
  +Set a new value
  +
  +=item ret: C<$input_filters>
  +( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>> )
   
   The first filter in the connection input filters chain.
   
  +If C<$new_input_filters> was passed, returns the previous value.
  +
  +=item since: 1.99_12
  +
   =back
   
  +For an example see: L<Bucket Brigades-based Protocol
  +Module|docs::2.0::user::handlers::protocols/Bucket_Brigades_based_Protocol_Module>
  +
  +
   
   
   
  @@ -158,7 +189,8 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item arg1 opt: C<$new_status> (C<L<:conn_keepalive
   constant|docs::2.0::api::Apache::Const/C__conn_keepalive_>>)
  @@ -221,7 +253,8 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item obj opt: C<$new_served> (integer)
   
  @@ -265,10 +298,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -284,10 +320,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$local_host> (string)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -304,10 +343,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$local_ip> (string)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -325,12 +367,15 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item arg1: C<$notes> (C<L<APR::Table|docs::2.0::api::APR::Table>>)
   
   =item ret:
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -339,22 +384,37 @@
   
   =head2 C<output_filters>
   
  -META: Autogenerated - needs to be reviewed/completed
  -
  -A list of output filters to be used for this connection
  +Get the first filter in a linked list of protocol level output
  +filters:
   
     $output_filters = $c->output_filters();
  +  $prev_output_filters = $r->output_filters($new_output_filters);
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
  +
  +=item opt arg1: C<$new_output_filters>
  +
  +Set a new value
   
  -=item ret: C<$output_filters> (C<L<Apache::Filter|docs::2.0::api::Apache::Filter>>)
  +=item ret: C<$output_filters>
  +( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>> )
   
   The first filter in the connection output filters chain.
   
  +If C<$new_output_filters> was passed, returns the previous value.
  +
  +=item since: 1.99_12
  +
   =back
   
  +For an example see: L<Bucket Brigades-based Protocol
  +Module|docs::2.0::user::handlers::protocols/Bucket_Brigades_based_Protocol_Module>
  +
  +
  +
   
   
   
  @@ -366,10 +426,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -386,10 +449,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$sa> (C<L<APR::SockAddr|docs::2.0::api::APR::SockAddr>>)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -404,10 +470,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$remote_ip> (string)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -424,10 +493,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$remote_host> (string)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -443,10 +515,13 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$remote_logname> (string)
   
  +=item since: 1.99_12
  +
   =back
   
   
  @@ -463,9 +538,12 @@
   
   =over 4
   
  -=item obj: C<$c> (C<L<Apache::Connection|docs::2.0::api::Apache::Connection>>)
  +=item obj: C<$c>
  +( C<L<Apache::Connection object|docs::2.0::api::Apache::Connection>> )
   
   =item ret: C<$sbh> (XXX)
  +
  +=item since: 1.99_12
   
   =back
   
  
  
  
  1.24      +117 -47   modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod
  
  Index: RequestRec.pod
  ===================================================================
  RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/RequestRec.pod,v
  retrieving revision 1.23
  retrieving revision 1.24
  diff -u -u -r1.23 -r1.24
  --- RequestRec.pod	24 Jul 2004 07:07:07 -0000	1.23
  +++ RequestRec.pod	24 Jul 2004 09:27:37 -0000	1.24
  @@ -682,16 +682,27 @@
   
   =head2 C<input_filters>
   
  -A list of input filters to be used for this request
  +Get/set the first filter in a linked list of request level input
  +filters:
   
  -  $input_filters = $r->input_filters();
  +  $input_filters      = $r->input_filters();
  +  $prev_input_filters = $r->input_filters($new_input_filters);
   
   =over 4
   
   =item obj: C<$r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  -=item ret: C<$input_filters> ( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>>
)
  +=item opt arg1: C<$new_input_filters>
  +
  +Set a new value
  +
  +=item ret: C<$input_filters>
  +( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>> )
  +
  +The first filter in the request level input filters chain.
  +
  +If C<$new_input_filters> was passed, returns the previous value.
   
   =item since: 1.99_12
   
  @@ -752,6 +763,9 @@
   
   
   
  +
  +
  +
   =head2 C<main>
   
   Get the main request record
  @@ -763,18 +777,17 @@
   =item obj: C<$r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  -=item ret: C<$main_r> ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>>
)
  -
  +=item ret: C<$main_r>
  +( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
   If the current request is a sub-request, this method returns a blessed
   reference to the main request structure. If the current request is the
  -main request, then this method returns undef.
  +main request, then this method returns C<undef>.
   
   To figure out whether you are inside a main request or a
   sub-request/internal redirect, use
   C<L<$r-E<gt>is_initial_req|docs::2.0::api::Apache::RequestUtil/C_is_initial_req_>>.
   
  -
   =item since: 1.99_12
   
   =back
  @@ -782,11 +795,11 @@
   
   
   
  -=head2 C<method>
   
  -META: Autogenerated - needs to be reviewed/completed
   
  -Request method (eg. GET, HEAD, POST, etc.)
  +=head2 C<method>
  +
  +Get the current request method (e.g. C<GET>, C<HEAD>, C<POST>, etc.):
   
     $method = $r->method();
   
  @@ -797,7 +810,9 @@
   
   =item ret: C<$method> ( string )
   
  -=item since: 1.99_12
  +The current method as a string
  +
  +=item since: 1.99_15
   
   =back
   
  @@ -805,6 +820,7 @@
   
   
   
  +
   =head2 C<method_number>
   
   What's HTTP method was issued by the client (C<Apache::M_GET>,
  @@ -829,23 +845,29 @@
   
   
   
  -=head2 C<mtime>
   
  -META: Autogenerated - needs to be reviewed/completed
  +
  +=head2 C<mtime>
   
   Last modified time of the requested resource
   
  -  $mtime = $r->mtime($new_mtime);
  -  $mtime = $r->mtime();
  +  $mtime      = $r->mtime();
  +  $prev_mtime = $r->mtime($new_mtime);
   
   =over 4
   
   =item obj: C<$r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  -=item opt arg1: C<$new_mtime> (number)
  +=item opt arg1: C<$new_mtime> ( number )
  +
  +a new value
  +
  +=item ret: C<$mtime> ( number )
   
  -=item ret: C<$mtime> (number)
  +the current value.
  +
  +if C<$new_mtime> was passed the previous value is returned.
   
   =item since: 1.99_12
   
  @@ -860,8 +882,6 @@
   
   =head2 C<next>
   
  -META: Autogenerated - needs to be reviewed/completed
  -
   Pointer to the redirected request if this is an external redirect
   
     $next_r = $r->next();
  @@ -874,6 +894,9 @@
   =item ret: C<$next_r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  +returns a blessed reference to the next (internal) request structure
  +or C<undef> if there is no next request.
  +
   =item since: 1.99_12
   
   =back
  @@ -883,8 +906,6 @@
   
   =head2 C<no_local_copy>
   
  -META: Autogenerated - needs to be reviewed/completed
  -
   There is no local copy of this response
   
     $status = $r->no_local_copy();
  @@ -900,35 +921,52 @@
   
   =back
   
  +Used internally in certain sub-requests to prevent sending
  +C<Apache::HTTP_NOT_MODIFIED> for a fragment or error documents. For
  +example see the implementation in F<modules/filters/mod_include.c>.
  +
  +Also used internally in
  +C<L<$r-E<gt>meets_conditions|docs::2.0::api::Apache::Response/C_meets_conditions_>>
  +-- if set to a true value, the conditions are always met.
   
   
   
   
  -=head2 C<notes>
   
  -META: Autogenerated - needs to be reviewed/completed
  +=head2 C<notes>
   
  -Notes from one module to another
  +Get/set text notes that can be passed from one module to another (not
  +only mod_perl, but modules in any other language):
   
  -  $notes = $r->notes();
  -  $notes = $r->notes($new_notes);
  +  $notes      = $r->notes();
  +  $prev_notes = $r->notes($new_notes);
   
   =over 4
   
   =item obj: C<$r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  -=item opt arg1: C<$new_notes> ( C<L<APR::Table object|docs::2.0::api::APR::Table>>
)
  +=item opt arg1: C<$new_notes>
  +( C<L<APR::Table object|docs::2.0::api::APR::Table>> )
  +
  +=item ret: C<$notes>
  +( C<L<APR::Table object|docs::2.0::api::APR::Table>> )
   
  -=item ret: C<$notes> ( C<L<APR::Table object|docs::2.0::api::APR::Table>>
)
  +the current notes table.
   
  +if the C<$new_notes> argument was passed, returns the previous value.
   
   =item since: 1.99_12
   
   =back
   
  -The 'notes' is for notes from one module to another, with no other set
  -purpose in mind...
  +If you want to pass Perl structures, you can use
  +C<L<$r-E<gt>pnotes|docs::2.0::api::Apache::RequestUtil/C_pnotes_>>.
  +
  +Also see
  +C<L<$c-E<gt>notes|docs::2.0::api::Apache::Connection/C_notes_>>
  +
  +
   
   
   
  @@ -936,19 +974,27 @@
   
   =head2 C<output_filters>
   
  -A pointer to the first filter in the output filter stack for this
  -request:
  +Get the first filter in a linked list of request level output filters:
   
  -  $output_filters = $r->output_filters();
  +  $output_filters      = $r->output_filters();
  +  $prev_output_filters = $r->output_filters($new_output_filters);
   
   =over 4
   
   =item obj: C<$r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  +=item opt arg1: C<$new_output_filters>
  +
  +Set a new value
  +
   =item ret: C<$output_filters>
   ( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>> )
   
  +The first filter in the request level output filters chain.
  +
  +If C<$new_output_filters> was passed, returns the previous value.
  +
   =item since: 1.99_12
   
   =back
  @@ -1044,8 +1090,6 @@
   
   =head2 C<pool>
   
  -META: Autogenerated - needs to be reviewed/completed
  -
   The pool associated with the request
   
     $p = $r->pool();
  @@ -1068,8 +1112,6 @@
   
   =head2 C<prev>
   
  -META: Autogenerated - needs to be reviewed/completed
  -
   Pointer to the previous request if this is an internal redirect
   
     $prev_r = $r->prev();
  @@ -1081,6 +1123,9 @@
   
   =item ret: C<$prev_r> ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>>
)
   
  +a blessed reference to the previous (internal) request structure or
  +C<undef> if there is no previous request.
  +
   =item since: 1.99_12
   
   =back
  @@ -1089,25 +1134,37 @@
   
   
   
  -=head2 C<proto_input_filters>
   
  -META: Autogenerated - needs to be reviewed/completed
   
  -A list of protocol level input filters to be used for this request
  +=head2 C<proto_input_filters>
  +
  +Get the first filter in a linked list of protocol level input filters:
   
  -  $proto_input_filters = $r->proto_input_filters();
  +  $proto_input_filters      = $r->proto_input_filters();
  +  $prev_proto_input_filters = $r->proto_input_filters($new_proto_input_filters);
   
   =over 4
   
   =item obj: C<$r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  -=item ret: C<$proto_input_filters> ( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>>
)
  +=item opt arg1: C<$new_proto_input_filters>
  +
  +Set a new value
  +
  +=item ret: C<$proto_input_filters>
  +( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>> )
  +
  +The first filter in the protocol level input filters chain.
  +
  +If C<$new_proto_input_filters> was passed, returns the previous value.
   
   =item since: 1.99_12
   
   =back
   
  +C<$r-E<gt>proto_input_filters> points to the same filter as
  +C<L<$r-E<gt>connection-E<gt>input_filters|docs::2.0::api::Apache::Connection/C_input_filters_>>.
   
   
   
  @@ -1134,25 +1191,38 @@
   
   
   
  -=head2 C<proto_output_filters>
   
  -META: Autogenerated - needs to be reviewed/completed
   
  -A list of protocol level output filters to be used for this request
  +=head2 C<proto_output_filters>
  +
  +Get the first filter in a linked list of protocol level output
  +filters:
   
  -  $proto_output_filters = $r->proto_output_filters();
  +  $proto_output_filters      = $r->proto_output_filters();
  +  $prev_proto_output_filters = $r->proto_output_filters($new_proto_output_filters);
   
   =over 4
   
   =item obj: C<$r>
   ( C<L<Apache::RequestRec object|docs::2.0::api::Apache::RequestRec>> )
   
  -=item ret: C<$proto_output_filters> ( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>>
)
  +=item opt arg1: C<$new_proto_output_filters>
  +
  +Set a new value
  +
  +=item ret: C<$proto_output_filters>
  +( C<L<Apache::Filter object|docs::2.0::api::Apache::Filter>> )
  +
  +The first filter in the protocol level output filters chain.
  +
  +If C<$new_proto_output_filters> was passed, returns the previous value.
   
   =item since: 1.99_12
   
   =back
   
  +C<$r-E<gt>proto_output_filters> points to the same filter as
  +C<L<$r-E<gt>connection-E<gt>output_filters|docs::2.0::api::Apache::Connection/C_output_filters_>>.
   
   
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org


Mime
View raw message