107 lines
31 KiB
HTML
107 lines
31 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Documentation</title>
|
|
<meta charset="utf-8" />
|
|
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
|
<link href="style.css" rel="stylesheet" />
|
|
<script src="script.js" type="text/javascript"></script>
|
|
|
|
|
|
<link href="search-results.html" rel="prefetch" />
|
|
</head>
|
|
<body>
|
|
<div id="page-header">
|
|
<div id="logotype">
|
|
<span>Documentation</span>
|
|
<nav>
|
|
<a href="http://dlang.org/">Dlang.org</a>
|
|
</nav>
|
|
</div>
|
|
|
|
<form action="search-docs.html" id="search">
|
|
<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
<div id="page-body">
|
|
<div id="page-content">
|
|
</div>
|
|
<div id="page-nav">
|
|
</div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
|
|
<script type="text/xml" id="search-index-container">
|
|
<adrdox>
|
|
<listing>
|
|
<decl id="1" type="module"><name>handy_http_handlers.path_handler</name><desc><div><p>Defines a path-matching request handler, that will match incoming requests
|
|
against a set of mappings based on the URL and HTTP method, and call a
|
|
handler depending on what's matched.</p></div></desc><link>handy_http_handlers.path_handler.html</link><decl id="2" type="function"><name>getMethodBit</name><desc><div><p>Maps each HTTP method to a bit value, so we can use bit-masking for handler mappings.</p></div></desc><link>handy_http_handlers.path_handler.getMethodBit.html</link></decl><decl id="3" type="function"><name>methodMaskFromMethods</name><desc><div><p>Computes a bitmask from a list of HTTP methods.</p></div></desc><link>handy_http_handlers.path_handler.methodMaskFromMethods.html</link></decl><decl id="4" type="function"><name>methodMaskFromAll</name><desc><div><p>Gets a bitmask that matches all HTTP methods.</p></div></desc><link>handy_http_handlers.path_handler.methodMaskFromAll.html</link></decl><decl id="5" type="class"><name>PathHandlerContextData</name><desc><div><p>Context data that may be attached to a request to provide additional data
|
|
from path matching results, like any path variables that were found.</p></div></desc><link>handy_http_handlers.path_handler.PathHandlerContextData.html</link><decl id="6" type="variable"><name>params</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.path_handler.PathHandlerContextData.params.html</link></decl><decl id="7" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.path_handler.PathHandlerContextData.this.html</link></decl></decl><decl id="8" type="function"><name>getPathParams</name><desc><div><p>Gets the set of path variables that were matched when the given request was
|
|
handled by the path handler.</p></div></desc><link>handy_http_handlers.path_handler.getPathParams.html</link></decl><decl id="9" type="function"><name>getPathParamAs</name><desc><div><p>Gets a specific path variable's value.</p></div></desc><link>handy_http_handlers.path_handler.getPathParamAs.html</link></decl><decl id="10" type="class"><name>PathHandler</name><desc><div><p>A request handler that maps incoming requests to a particular handler based
|
|
on the request's URL path and/or HTTP method (GET, POST, etc.).</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.html</link><decl id="11" type="constructor"><name>this</name><desc><div><p>Constructs a new path handler with initially no mappings, and a default
|
|
notFoundHandler that simply sets a 404 status.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.this.html</link></decl><decl id="12" type="function"><name>addMapping</name><desc><div><p>Adds a mapping to this handler, such that requests which match the given
|
|
method and pattern will be handed off to the given handler.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.1.html</link></decl><decl id="13" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.2.html</link></decl><decl id="14" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.3.html</link></decl><decl id="15" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.4.html</link></decl><decl id="16" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.5.html</link></decl><decl id="17" type="function"><name>setNotFoundHandler</name><desc><div><p>Sets the handler that will be called for requests that don't match any
|
|
pre-configured mappings.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.setNotFoundHandler.html</link></decl><decl id="18" type="function"><name>handle</name><desc><div><p>Handles a request by looking for a mapped handler whose method and pattern
|
|
match the request's, and letting that handler handle the request. If no
|
|
match is found, the notFoundHandler will take care of it.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.handle.html</link></decl><decl id="19" type="function"><name>registerHandlers</name><desc><div><p>Adds mappings to this path handler which correspond to functions defined
|
|
in the given symbol which have been annotated with the <tt class="inline-code">@PathMapping</tt>
|
|
attribute (or any simplified aliases like <tt class="inline-code">@GetMapping</tt>).</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.registerHandlers.html</link></decl></decl><decl id="20" type="struct"><name>PathMapping</name><desc><div><p>A user-defined attribute that, when added to a function, allows that
|
|
function to be registered automatically by a path handler when you call
|
|
its <tt class="inline-code">registerHandlers</tt> method on the module containing the function.</p></div></desc><link>handy_http_handlers.path_handler.PathMapping.html</link><decl id="21" type="variable"><name>method</name><desc><div><p>The HTTP method that the mapping accepts.</p></div></desc><link>handy_http_handlers.path_handler.PathMapping.method.html</link></decl><decl id="22" type="variable"><name>pattern</name><desc><div><p>The path pattern for the mapping.</p></div></desc><link>handy_http_handlers.path_handler.PathMapping.pattern.html</link></decl></decl><decl id="23" type="struct"><name>GetMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP GET mappings only.</p></div></desc><link>handy_http_handlers.path_handler.GetMapping.html</link><decl id="24" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.GetMapping.pattern.html</link></decl></decl><decl id="25" type="struct"><name>PostMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP POST mappings only.</p></div></desc><link>handy_http_handlers.path_handler.PostMapping.html</link><decl id="26" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.PostMapping.pattern.html</link></decl></decl><decl id="27" type="struct"><name>PutMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP PUT mappings only.</p></div></desc><link>handy_http_handlers.path_handler.PutMapping.html</link><decl id="28" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.PutMapping.pattern.html</link></decl></decl><decl id="29" type="struct"><name>DeleteMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP DELETE mappings only.</p></div></desc><link>handy_http_handlers.path_handler.DeleteMapping.html</link><decl id="30" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.DeleteMapping.pattern.html</link></decl></decl><decl id="31" type="struct"><name>PatchMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP PATCH mappings only.</p></div></desc><link>handy_http_handlers.path_handler.PatchMapping.html</link><decl id="32" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.PatchMapping.pattern.html</link></decl></decl></decl><decl id="33" type="module"><name>handy_http_handlers</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.html</link><decl id="34" type="module"><name>handy_http_handlers.path_handler</name><desc><div><p>Defines a path-matching request handler, that will match incoming requests
|
|
against a set of mappings based on the URL and HTTP method, and call a
|
|
handler depending on what's matched.</p></div></desc><link>handy_http_handlers.path_handler.html</link><decl id="35" type="function"><name>getMethodBit</name><desc><div><p>Maps each HTTP method to a bit value, so we can use bit-masking for handler mappings.</p></div></desc><link>handy_http_handlers.path_handler.getMethodBit.html</link></decl><decl id="36" type="function"><name>methodMaskFromMethods</name><desc><div><p>Computes a bitmask from a list of HTTP methods.</p></div></desc><link>handy_http_handlers.path_handler.methodMaskFromMethods.html</link></decl><decl id="37" type="function"><name>methodMaskFromAll</name><desc><div><p>Gets a bitmask that matches all HTTP methods.</p></div></desc><link>handy_http_handlers.path_handler.methodMaskFromAll.html</link></decl><decl id="38" type="class"><name>PathHandlerContextData</name><desc><div><p>Context data that may be attached to a request to provide additional data
|
|
from path matching results, like any path variables that were found.</p></div></desc><link>handy_http_handlers.path_handler.PathHandlerContextData.html</link><decl id="39" type="variable"><name>params</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.path_handler.PathHandlerContextData.params.html</link></decl><decl id="40" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.path_handler.PathHandlerContextData.this.html</link></decl></decl><decl id="41" type="function"><name>getPathParams</name><desc><div><p>Gets the set of path variables that were matched when the given request was
|
|
handled by the path handler.</p></div></desc><link>handy_http_handlers.path_handler.getPathParams.html</link></decl><decl id="42" type="function"><name>getPathParamAs</name><desc><div><p>Gets a specific path variable's value.</p></div></desc><link>handy_http_handlers.path_handler.getPathParamAs.html</link></decl><decl id="43" type="class"><name>PathHandler</name><desc><div><p>A request handler that maps incoming requests to a particular handler based
|
|
on the request's URL path and/or HTTP method (GET, POST, etc.).</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.html</link><decl id="44" type="constructor"><name>this</name><desc><div><p>Constructs a new path handler with initially no mappings, and a default
|
|
notFoundHandler that simply sets a 404 status.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.this.html</link></decl><decl id="45" type="function"><name>addMapping</name><desc><div><p>Adds a mapping to this handler, such that requests which match the given
|
|
method and pattern will be handed off to the given handler.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.1.html</link></decl><decl id="46" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.2.html</link></decl><decl id="47" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.3.html</link></decl><decl id="48" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.4.html</link></decl><decl id="49" type="function"><name>addMapping</name><desc><div></div></desc><link>handy_http_handlers.path_handler.PathHandler.addMapping.5.html</link></decl><decl id="50" type="function"><name>setNotFoundHandler</name><desc><div><p>Sets the handler that will be called for requests that don't match any
|
|
pre-configured mappings.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.setNotFoundHandler.html</link></decl><decl id="51" type="function"><name>handle</name><desc><div><p>Handles a request by looking for a mapped handler whose method and pattern
|
|
match the request's, and letting that handler handle the request. If no
|
|
match is found, the notFoundHandler will take care of it.</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.handle.html</link></decl><decl id="52" type="function"><name>registerHandlers</name><desc><div><p>Adds mappings to this path handler which correspond to functions defined
|
|
in the given symbol which have been annotated with the <tt class="inline-code">@PathMapping</tt>
|
|
attribute (or any simplified aliases like <tt class="inline-code">@GetMapping</tt>).</p></div></desc><link>handy_http_handlers.path_handler.PathHandler.registerHandlers.html</link></decl></decl><decl id="53" type="struct"><name>PathMapping</name><desc><div><p>A user-defined attribute that, when added to a function, allows that
|
|
function to be registered automatically by a path handler when you call
|
|
its <tt class="inline-code">registerHandlers</tt> method on the module containing the function.</p></div></desc><link>handy_http_handlers.path_handler.PathMapping.html</link><decl id="54" type="variable"><name>method</name><desc><div><p>The HTTP method that the mapping accepts.</p></div></desc><link>handy_http_handlers.path_handler.PathMapping.method.html</link></decl><decl id="55" type="variable"><name>pattern</name><desc><div><p>The path pattern for the mapping.</p></div></desc><link>handy_http_handlers.path_handler.PathMapping.pattern.html</link></decl></decl><decl id="56" type="struct"><name>GetMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP GET mappings only.</p></div></desc><link>handy_http_handlers.path_handler.GetMapping.html</link><decl id="57" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.GetMapping.pattern.html</link></decl></decl><decl id="58" type="struct"><name>PostMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP POST mappings only.</p></div></desc><link>handy_http_handlers.path_handler.PostMapping.html</link><decl id="59" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.PostMapping.pattern.html</link></decl></decl><decl id="60" type="struct"><name>PutMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP PUT mappings only.</p></div></desc><link>handy_http_handlers.path_handler.PutMapping.html</link><decl id="61" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.PutMapping.pattern.html</link></decl></decl><decl id="62" type="struct"><name>DeleteMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP DELETE mappings only.</p></div></desc><link>handy_http_handlers.path_handler.DeleteMapping.html</link><decl id="63" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.DeleteMapping.pattern.html</link></decl></decl><decl id="64" type="struct"><name>PatchMapping</name><desc><div><p>A simplified version of <tt class="inline-code">PathMapping</tt> for HTTP PATCH mappings only.</p></div></desc><link>handy_http_handlers.path_handler.PatchMapping.html</link><decl id="65" type="variable"><name>pattern</name><desc><div><p>See <tt class="inline-code">PathMapping.pattern</tt>.</p></div></desc><link>handy_http_handlers.path_handler.PatchMapping.pattern.html</link></decl></decl></decl><decl id="66" type="module"><name>handy_http_handlers.filtered_handler</name><desc><div><p>Defines a &quot;filtered&quot; request handler, that applies an ordered set of filters
|
|
(otherwise known as a &quot;filter chain&quot;) before and after handling a request,
|
|
as a means of adding a simple middleware layer to HTTP request processing.</p></div></desc><link>handy_http_handlers.filtered_handler.html</link><decl id="67" type="interface"><name>HttpRequestFilter</name><desc><div><p>A filter that can be applied to an HTTP request. If the filter determines
|
|
that it's okay to continue processing the request, it should call
|
|
<tt class="inline-code">filterChain.doFilter(request, response)</tt> to continue the chain. If the
|
|
chain is not continued, request processing ends at this filter, and the
|
|
current response is sent back to the client.</p></div></desc><link>handy_http_handlers.filtered_handler.HttpRequestFilter.html</link><decl id="68" type="function"><name>doFilter</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.filtered_handler.HttpRequestFilter.doFilter.html</link></decl></decl><decl id="69" type="class"><name>FilterChain</name><desc><div><p>A filter chain is a singly-linked list that represents a series of filters
|
|
to be applied when processing a request.</p></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.html</link><decl id="70" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.this.html</link></decl><decl id="71" type="function"><name>doFilter</name><desc><div><p>Applies this filter chain link's filter to the given request and
|
|
response, and then if there's another link in the chain, calls it to
|
|
apply its filter thereafter, and so on until the chain is complete or
|
|
a filter has short-circuited without calling <tt class="inline-code">filterChain.doFilter</tt>.</p></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.doFilter.html</link></decl><decl id="72" type="static function"><name>build</name><desc><div><p>Builds a filter chain from a list of request filters.</p></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.build.html</link></decl></decl><decl id="73" type="class"><name>BaseHandlerRequestFilter</name><desc><div><p>A simple base filter that should always sit at the bottom of the filter
|
|
chain, which just calls a request handler.</p></div></desc><link>handy_http_handlers.filtered_handler.BaseHandlerRequestFilter.html</link><decl id="74" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.filtered_handler.BaseHandlerRequestFilter.this.html</link></decl><decl id="75" type="function"><name>doFilter</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.filtered_handler.BaseHandlerRequestFilter.doFilter.html</link></decl></decl><decl id="76" type="class"><name>FilteredHandler</name><desc><div><p>The FilteredHandler is a request handler you can add to your server to apply
|
|
a filter chain to an underlying request handler.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.html</link><decl id="77" type="constructor"><name>this</name><desc><div><p>Constructs a filtered handler that applies the given filter chain. Note
|
|
that you should probabconstly use the other constructor for most cases, but
|
|
if you really want to provide a custom filter chain, you'll most likely
|
|
want to add the <tt class="inline-code">BaseHandlerRequestFilter</tt> as the last one in the chain.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.this.1.html</link></decl><decl id="78" type="constructor"><name>this</name><desc><div><p>Constructs a filtered handler that applies the given set of filters, in
|
|
order, before potentially calling the given base handler.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.this.2.html</link></decl><decl id="79" type="function"><name>handle</name><desc><div><p>Handles an incoming request by simply calling the filter chain on it.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.handle.html</link></decl></decl></decl><decl id="80" type="module"><name>handy_http_handlers.path_handler_sample_module</name><desc><div><p>This module defines some path mapping functions to help test the path
|
|
handler's function for registering annotated functions.</p></div></desc><link>handy_http_handlers.path_handler_sample_module.html</link><decl id="81" type="function"><name>h1</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.path_handler_sample_module.h1.html</link></decl><decl id="82" type="function"><name>h2</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.path_handler_sample_module.h2.html</link></decl><decl id="83" type="function"><name>h3</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.path_handler_sample_module.h3.html</link></decl></decl></decl><decl id="84" type="module"><name>handy_http_handlers.filtered_handler</name><desc><div><p>Defines a &quot;filtered&quot; request handler, that applies an ordered set of filters
|
|
(otherwise known as a &quot;filter chain&quot;) before and after handling a request,
|
|
as a means of adding a simple middleware layer to HTTP request processing.</p></div></desc><link>handy_http_handlers.filtered_handler.html</link><decl id="85" type="interface"><name>HttpRequestFilter</name><desc><div><p>A filter that can be applied to an HTTP request. If the filter determines
|
|
that it's okay to continue processing the request, it should call
|
|
<tt class="inline-code">filterChain.doFilter(request, response)</tt> to continue the chain. If the
|
|
chain is not continued, request processing ends at this filter, and the
|
|
current response is sent back to the client.</p></div></desc><link>handy_http_handlers.filtered_handler.HttpRequestFilter.html</link><decl id="86" type="function"><name>doFilter</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.filtered_handler.HttpRequestFilter.doFilter.html</link></decl></decl><decl id="87" type="class"><name>FilterChain</name><desc><div><p>A filter chain is a singly-linked list that represents a series of filters
|
|
to be applied when processing a request.</p></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.html</link><decl id="88" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.this.html</link></decl><decl id="89" type="function"><name>doFilter</name><desc><div><p>Applies this filter chain link's filter to the given request and
|
|
response, and then if there's another link in the chain, calls it to
|
|
apply its filter thereafter, and so on until the chain is complete or
|
|
a filter has short-circuited without calling <tt class="inline-code">filterChain.doFilter</tt>.</p></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.doFilter.html</link></decl><decl id="90" type="static function"><name>build</name><desc><div><p>Builds a filter chain from a list of request filters.</p></div></desc><link>handy_http_handlers.filtered_handler.FilterChain.build.html</link></decl></decl><decl id="91" type="class"><name>BaseHandlerRequestFilter</name><desc><div><p>A simple base filter that should always sit at the bottom of the filter
|
|
chain, which just calls a request handler.</p></div></desc><link>handy_http_handlers.filtered_handler.BaseHandlerRequestFilter.html</link><decl id="92" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_handlers.filtered_handler.BaseHandlerRequestFilter.this.html</link></decl><decl id="93" type="function"><name>doFilter</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.filtered_handler.BaseHandlerRequestFilter.doFilter.html</link></decl></decl><decl id="94" type="class"><name>FilteredHandler</name><desc><div><p>The FilteredHandler is a request handler you can add to your server to apply
|
|
a filter chain to an underlying request handler.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.html</link><decl id="95" type="constructor"><name>this</name><desc><div><p>Constructs a filtered handler that applies the given filter chain. Note
|
|
that you should probabconstly use the other constructor for most cases, but
|
|
if you really want to provide a custom filter chain, you'll most likely
|
|
want to add the <tt class="inline-code">BaseHandlerRequestFilter</tt> as the last one in the chain.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.this.1.html</link></decl><decl id="96" type="constructor"><name>this</name><desc><div><p>Constructs a filtered handler that applies the given set of filters, in
|
|
order, before potentially calling the given base handler.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.this.2.html</link></decl><decl id="97" type="function"><name>handle</name><desc><div><p>Handles an incoming request by simply calling the filter chain on it.</p></div></desc><link>handy_http_handlers.filtered_handler.FilteredHandler.handle.html</link></decl></decl></decl><decl id="98" type="module"><name>handy_http_handlers.path_handler_sample_module</name><desc><div><p>This module defines some path mapping functions to help test the path
|
|
handler's function for registering annotated functions.</p></div></desc><link>handy_http_handlers.path_handler_sample_module.html</link><decl id="99" type="function"><name>h1</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.path_handler_sample_module.h1.html</link></decl><decl id="100" type="function"><name>h2</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.path_handler_sample_module.h2.html</link></decl><decl id="101" type="function"><name>h3</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_handlers.path_handler_sample_module.h3.html</link></decl></decl></listing>
|
|
<index>
|
|
</index>
|
|
</adrdox>
|
|
</script>
|
|
<script src="search-docs.js"></script>
|
|
</body></html>
|