diff options
Diffstat (limited to 'docs/manual/developer')
| -rw-r--r-- | docs/manual/developer/API.html.en | 2 | ||||
| -rw-r--r-- | docs/manual/developer/filters.html.en | 2 | ||||
| -rw-r--r-- | docs/manual/developer/hooks.html.en | 14 | ||||
| -rw-r--r-- | docs/manual/developer/modguide.html.en | 2 | ||||
| -rw-r--r-- | docs/manual/developer/modules.html.en | 2 | ||||
| -rw-r--r-- | docs/manual/developer/modules.html.ja.utf8 | 2 | ||||
| -rw-r--r-- | docs/manual/developer/new_api_2_4.html.en | 2 | ||||
| -rw-r--r-- | docs/manual/developer/output-filters.html.en | 55 | ||||
| -rw-r--r-- | docs/manual/developer/request.html.en | 2 | ||||
| -rw-r--r-- | docs/manual/developer/thread_safety.html.en | 2 |
10 files changed, 42 insertions, 43 deletions
diff --git a/docs/manual/developer/API.html.en b/docs/manual/developer/API.html.en index 73ff8526..87fb9718 100644 --- a/docs/manual/developer/API.html.en +++ b/docs/manual/developer/API.html.en @@ -110,7 +110,7 @@ <li><img alt="" src="../images/down.gif" /> <a href="#handlers">How handlers work</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#pools">Resource allocation and resource pools</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#config">Configuration, commands and the like</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="basics" id="basics">Basic concepts</a></h2> diff --git a/docs/manual/developer/filters.html.en b/docs/manual/developer/filters.html.en index 2651a4db..cb593c33 100644 --- a/docs/manual/developer/filters.html.en +++ b/docs/manual/developer/filters.html.en @@ -37,7 +37,7 @@ <li><img alt="" src="../images/down.gif" /> <a href="#howinserted">How are filters inserted?</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#asis">Asis</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#conclusion">Explanations</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="types" id="types">Filter Types</a></h2> diff --git a/docs/manual/developer/hooks.html.en b/docs/manual/developer/hooks.html.en index 3f7c8411..d8a33350 100644 --- a/docs/manual/developer/hooks.html.en +++ b/docs/manual/developer/hooks.html.en @@ -31,15 +31,15 @@ date.</p> </div> - <p>In general, a hook function is one that the Apache HTTP Server - will call at some point during the processing of a request. - Modules can provide functions that are called, and specify when + <p>In general, a hook function is one that the Apache HTTP Server + will call at some point during the processing of a request. + Modules can provide functions that are called, and specify when they get called in comparison to other modules.</p> </div> <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#corehooks">Core Hooks</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#create">Creating a hook function</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#hooking">Hooking the hook</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="corehooks" id="corehooks">Core Hooks</a></h2> @@ -123,7 +123,7 @@ <p>The first hook that does <em>not</em> return <code>DECLINED</code> stops the loop and its return value is returned from the hook - caller. Note that <code>DECLINED</code> is the traditional + caller. Note that <code>DECLINED</code> is the traditional hook return value meaning "I didn't do anything", but it can be whatever suits you.</p> @@ -162,7 +162,7 @@ ret=ap_run_do_something(r, n);</pre> <p>Include the appropriate header, and define a static function of the correct type:</p> - <pre class="prettyprint lang-c">static int my_something_doer(request_rec *r, int n)<br /> + <pre class="prettyprint lang-c">static int my_something_doer(request_rec *r, int n) { ... return OK; @@ -202,7 +202,7 @@ mode MODULE_VAR_EXPORT my_module = order relative to each other, but, of course, all modules using <code>APR_HOOK_FIRST</code> will be run before <code>APR_HOOK_MIDDLE</code> which are before <code>APR_HOOK_LAST</code>. Modules that don't care - when they are run should use <code>APR_HOOK_MIDDLE</code>. <em>These + when they are run should use <code>APR_HOOK_MIDDLE</code>. <em>These values are spaced out, so that positions like <code>APR_HOOK_FIRST-2</code> are possible to hook slightly earlier than other functions.</em></p> diff --git a/docs/manual/developer/modguide.html.en b/docs/manual/developer/modguide.html.en index b03b9e93..901ba5a7 100644 --- a/docs/manual/developer/modguide.html.en +++ b/docs/manual/developer/modguide.html.en @@ -37,7 +37,7 @@ Server 2.4</p> <li><img alt="" src="../images/down.gif" /> <a href="#context">Context aware configurations</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#summary">Summing up</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#snippets">Some useful snippets of code</a></li> -</ul><h3>See also</h3><ul class="seealso"><li><a href="request.html">Request Processing in Apache 2.4</a></li><li><a href="hooks.html">Apache 2.x Hook Functions</a></li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="request.html">Request Processing in Apache 2.4</a></li><li><a href="hooks.html">Apache 2.x Hook Functions</a></li><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="introduction" id="introduction">Introduction</a></h2> diff --git a/docs/manual/developer/modules.html.en b/docs/manual/developer/modules.html.en index 22fb59aa..f3967496 100644 --- a/docs/manual/developer/modules.html.en +++ b/docs/manual/developer/modules.html.en @@ -34,7 +34,7 @@ </div> <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#easy">The easier changes ...</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#messy">The messier changes...</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="easy" id="easy">The easier changes ...</a></h2> diff --git a/docs/manual/developer/modules.html.ja.utf8 b/docs/manual/developer/modules.html.ja.utf8 index 99f56b64..56ae40ec 100644 --- a/docs/manual/developer/modules.html.ja.utf8 +++ b/docs/manual/developer/modules.html.ja.utf8 @@ -38,7 +38,7 @@ </div> <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#easy">簡単な変更点</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#messy">もっと厄介な変更点…</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">コメント</a></li></ul></div> +</ul><h3>参照</h3><ul class="seealso"><li><a href="#comments_section">コメント</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="easy" id="easy">簡単な変更点</a></h2> diff --git a/docs/manual/developer/new_api_2_4.html.en b/docs/manual/developer/new_api_2_4.html.en index bf944585..1e12eecd 100644 --- a/docs/manual/developer/new_api_2_4.html.en +++ b/docs/manual/developer/new_api_2_4.html.en @@ -51,7 +51,7 @@ </div> <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#api_changes">Changed APIs</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#upgrading">Specific information on upgrading modules from 2.2</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="api_changes" id="api_changes">Changed APIs</a></h2> diff --git a/docs/manual/developer/output-filters.html.en b/docs/manual/developer/output-filters.html.en index ece2d23e..d7eedcbc 100644 --- a/docs/manual/developer/output-filters.html.en +++ b/docs/manual/developer/output-filters.html.en @@ -44,7 +44,7 @@ <li><img alt="" src="../images/down.gif" /> <a href="#buffer">Buffering buckets</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#nonblock">Non-blocking bucket reads</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#rules">Ten rules for output filters</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="basics" id="basics">Filters and bucket brigades</a></h2> @@ -131,12 +131,12 @@ brigade should have no side effects (such as changing any state private to the filter).</p> - <div class="example"><h3>How to handle an empty brigade</h3><pre class="prettyprint lang-c"> apr_status_t dummy_filter(ap_filter_t *f, apr_bucket_brigade *bb)<br /> - { - if (APR_BRIGADE_EMPTY(bb)) { - return APR_SUCCESS; - } - ....</pre> + <div class="example"><h3>How to handle an empty brigade</h3><pre class="prettyprint lang-c">apr_status_t dummy_filter(ap_filter_t *f, apr_bucket_brigade *bb) +{ + if (APR_BRIGADE_EMPTY(bb)) { + return APR_SUCCESS; + } + ...</pre> </div> </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> @@ -281,16 +281,16 @@ const char *data; apr_size_t length; while ((e = APR_BRIGADE_FIRST(bb)) != APR_BRIGADE_SENTINEL(bb)) { - rv = apr_bucket_read(e, &data, &length, APR_BLOCK_READ); - if (rv) ...; - /* Remove bucket e from bb. */ - APR_BUCKET_REMOVE(e); - /* Insert it into temporary brigade. */ - APR_BRIGADE_INSERT_HEAD(tmpbb, e); - /* Pass brigade downstream. */ - rv = ap_pass_brigade(f->next, tmpbb); - if (rv) ...; - apr_brigade_cleanup(tmpbb); + rv = apr_bucket_read(e, &data, &length, APR_BLOCK_READ); + if (rv) ...; + /* Remove bucket e from bb. */ + APR_BUCKET_REMOVE(e); + /* Insert it into temporary brigade. */ + APR_BRIGADE_INSERT_HEAD(tmpbb, e); + /* Pass brigade downstream. */ + rv = ap_pass_brigade(f->next, tmpbb); + if (rv) ...; + apr_brigade_cleanup(tmpbb); }</pre> </div> @@ -307,26 +307,24 @@ while ((e = APR_BRIGADE_FIRST(bb)) != APR_BRIGADE_SENTINEL(bb)) { a new brigade per invocation as described in the <a href="#brigade">Brigade structure</a> section.</p> <div class="example"><h3>Example code to maintain filter state</h3><pre class="prettyprint lang-c">struct dummy_state { - apr_bucket_brigade *tmpbb; - int filter_state; - ... + apr_bucket_brigade *tmpbb; + int filter_state; + ... }; apr_status_t dummy_filter(ap_filter_t *f, apr_bucket_brigade *bb) { - struct dummy_state *state; state = f->ctx; if (state == NULL) { - /* First invocation for this response: initialise state structure. - */ - f->ctx = state = apr_palloc(f->r->pool, sizeof *state); - - state->tmpbb = apr_brigade_create(f->r->pool, f->c->bucket_alloc); - state->filter_state = ...; + /* First invocation for this response: initialise state structure. + */ + f->ctx = state = apr_palloc(f->r->pool, sizeof *state); + state->tmpbb = apr_brigade_create(f->r->pool, f->c->bucket_alloc); + state->filter_state = ...; } ...</pre> </div> @@ -421,7 +419,8 @@ while ((e = APR_BRIGADE_FIRST(bb)) != APR_BRIGADE_SENTINEL(bb)) { /* Retry, using a blocking read. */ mode = APR_BLOCK_READ; continue; - } else if (rv != APR_SUCCESS) { + } + else if (rv != APR_SUCCESS) { /* handle errors */ } diff --git a/docs/manual/developer/request.html.en b/docs/manual/developer/request.html.en index 8b552c51..81bad129 100644 --- a/docs/manual/developer/request.html.en +++ b/docs/manual/developer/request.html.en @@ -58,7 +58,7 @@ <li><img alt="" src="../images/down.gif" /> <a href="#security">The Security Phase</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#preparation">The Preparation Phase</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#handler">The Handler Phase</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="processing" id="processing">The Request Processing Cycle</a></h2> diff --git a/docs/manual/developer/thread_safety.html.en b/docs/manual/developer/thread_safety.html.en index 5cf392a7..136c6f84 100644 --- a/docs/manual/developer/thread_safety.html.en +++ b/docs/manual/developer/thread_safety.html.en @@ -38,7 +38,7 @@ <li><img alt="" src="../images/down.gif" /> <a href="#functions">Common standard troublesome functions</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#commonlibs">Common 3rd Party Libraries</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#liblist">Library List</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +</ul><h3>See also</h3><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="variables" id="variables">Global and static variables</a></h2> |