pier 01/05/09 23:40:35
Added: connectors/docs/api doc.connection_provider.html
pkg.connection_provider.html
Log:
API Documentation for the Connection Provider package
Revision Changes Path
1.1
jakarta-tomcat-4.0/connectors/docs/api/doc.connection_provider.html
Index: doc.connection_provider.html
===================================================================
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; iso-8859-1">
<title>WebApp Library - Packages List</title>
</head>
<body link="#0000ff" vlink="#0000ff" alink="#0000ff"
bgcolor="#ffffff" text="#000000">
<table width="100%" cellspacing="0" cellpadding="2" border="1">
<tr>
<td bgcolor="ccccff">
<table border="0" width="100%" cellspacing="0" cellpadding="0">
<tr>
<td bgcolor="ccccff" align="left">
<font size="+1" face="arial,helvetica,sans serif">
<b>WebApp Library</b>
</font>
</td>
<td bgcolor="ccccff" align="right">
<font size="+1" face="arial,helvetica,sans serif">
<b>Connection Provider package</b>
</font>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>
<table width="100%" cellspacing="0" cellpadding="2" border="1">
<tr>
<td bgcolor="eeeeff" align="left">
<font face="arial,helvetica,sans serif">
<b>Classes</b>
</font>
</td>
</tr>
<tr>
<td>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
<nobr><a href="doc.connection_provider.html#wa_provider">struct
wa_provider</a></nobr>
</font>
</dt>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a
href="doc.connection_provider.html#wa_provider-const_char_*(*connect)">const const
char *(*connect)(wa_connection *conn, char *param)</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a
href="doc.connection_provider.html#wa_provider-const_char_*(*deploy)">const const char
*(*deploy)(wa_application *appl)</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a
href="doc.connection_provider.html#wa_provider-const_char_*(*destroy)">const const
char *(*destroy)(void)</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a
href="doc.connection_provider.html#wa_provider-const_char_*(*init)">const const char
*(*init)(void)</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a href="doc.connection_provider.html#wa_provider-desc">
const char *desc</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a
href="doc.connection_provider.html#wa_provider-int_(*applinfo)">int
(*applinfo)(wa_application *appl, char *buf, int len)</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a
href="doc.connection_provider.html#wa_provider-int_(*conninfo)">int
(*conninfo)(wa_connection *conn, char *buf, int len)</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a href="doc.connection_provider.html#wa_provider-name">
const char *name</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a href="doc.connection_provider.html#wa_provider-vers">
const char *vers</a></nobr>
</font>
</dd>
<dd>
<font size="-1" face="arial,helvetica,sans serif">
<nobr><a
href="doc.connection_provider.html#wa_provider-void_(*handle)">void
(*handle)(wa_request *req)</a></nobr>
</font>
</dd>
</dl>
</td>
</tr>
</table>
<br>
<table width="100%" cellspacing="0" cellpadding="2" border="1">
<tr>
<td bgcolor="ccccff" align="left">
<font size="+1" face="arial,helvetica,sans serif">
<a name="wa_provider">
<b>Class "wa_provider" Detail:</b>
</a>
</font>
</td>
</tr>
</table>
<font size="+1" face="arial,helvetica,sans serif">
<b>wa_provider</b>
</font>
<dl>
<dt><code>struct wa_provider {</code></dt>
<dd><code>const const char *(*connect)(wa_connection *conn, char
*param);</code></dd>
<dd><code>const const char *(*deploy)(wa_application *appl);</code></dd>
<dd><code>const const char *(*destroy)(void);</code></dd>
<dd><code>const const char *(*init)(void);</code></dd>
<dd><code> const char *desc;</code></dd>
<dd><code>int (*applinfo)(wa_application *appl, char *buf, int
len);</code></dd>
<dd><code>int (*conninfo)(wa_connection *conn, char *buf, int len);</code></dd>
<dd><code> const char *name;</code></dd>
<dd><code> const char *vers;</code></dd>
<dd><code>void (*handle)(wa_request *req);</code></dd>
<dt><code>};</code></dt>
</dl>
<p>
<font face="arial,helvetica,sans serif">
The WebApp Library connection provider structure.
<br>
This structure contains all data and function pointers to be implemented
by a connection provider.
</font>
</p>
<table width="100%" cellspacing="0" cellpadding="2" border="1">
<tr>
<td bgcolor="eeeeff" align="left">
<font face="arial,helvetica,sans serif">
<b>Class "wa_provider" Functions:</b>
</font>
</td>
</tr>
</table>
<a name="wa_provider-const_char_*(*connect)">
<font size="+1" face="arial,helvetica,sans serif">
<b>const char *(*connect)</b>
</font>
<dl>
<dt><code>const const char *(*connect)(wa_connection *conn, char
*param);</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
Configure a connection with the parameter from the web server
configuration file.
</font>
</dt>
<dt>
<font face="arial,helvetica,sans serif">
<b>Parameters</b>
</font>
</dt>
<dd>
<code>conn</code> -
<font face="arial,helvetica,sans serif">
The connection to configure.
</font>
</dd>
<dd>
<code>param</code> -
<font face="arial,helvetica,sans serif">
The extra parameter from web server configuration.
</font>
</dd>
<dt>
<font face="arial,helvetica,sans serif">
<b>Return Value</b>
</font>
</dt>
<dd>
<font face="arial,helvetica,sans serif">
An error message or NULL.
</font>
</dd>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-const_char_*(*deploy)">
<font size="+1" face="arial,helvetica,sans serif">
<b>const char *(*deploy)</b>
</font>
<dl>
<dt><code>const const char *(*deploy)(wa_application *appl);</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
Configure a connection with the parameter from the web server
configuration file.
</font>
</dt>
<dt>
<font face="arial,helvetica,sans serif">
<b>Parameters</b>
</font>
</dt>
<dd>
<code>conn</code> -
<font face="arial,helvetica,sans serif">
The connection to configure.
</font>
</dd>
<dd>
<code>param</code> -
<font face="arial,helvetica,sans serif">
The extra parameter from web server configuration.
</font>
</dd>
<dt>
<font face="arial,helvetica,sans serif">
<b>Return Value</b>
</font>
</dt>
<dd>
<font face="arial,helvetica,sans serif">
An error message or NULL.
</font>
</dd>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-const_char_*(*destroy)">
<font size="+1" face="arial,helvetica,sans serif">
<b>const char *(*destroy)</b>
</font>
<dl>
<dt><code>const const char *(*destroy)(void);</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
Cleans up all resources allocated by the provider.
</font>
</dt>
<dt>
<font face="arial,helvetica,sans serif">
<b>Return Value</b>
</font>
</dt>
<dd>
<font face="arial,helvetica,sans serif">
An error message or NULL.
</font>
</dd>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-const_char_*(*init)">
<font size="+1" face="arial,helvetica,sans serif">
<b>const char *(*init)</b>
</font>
<dl>
<dt><code>const const char *(*init)(void);</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
Initialize a provider.
</font>
</dt>
<dt>
<font face="arial,helvetica,sans serif">
<b>Return Value</b>
</font>
</dt>
<dd>
<font face="arial,helvetica,sans serif">
An error message or NULL.
</font>
</dd>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-int_(*applinfo)">
<font size="+1" face="arial,helvetica,sans serif">
<b>int (*applinfo)</b>
</font>
<dl>
<dt><code>int (*applinfo)(wa_application *appl, char *buf, int
len);</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
Describe the configuration member found in a web application.
</font>
</dt>
<dt>
<font face="arial,helvetica,sans serif">
<b>Parameters</b>
</font>
</dt>
<dd>
<code>appl</code> -
<font face="arial,helvetica,sans serif">
The application for wich a description must be produced.
</font>
</dd>
<dd>
<code>buf</code> -
<font face="arial,helvetica,sans serif">
The buffer where the description must be stored.
</font>
</dd>
<dd>
<code>len</code> -
<font face="arial,helvetica,sans serif">
The buffer length.
</font>
</dd>
<dt>
<font face="arial,helvetica,sans serif">
<b>Return Value</b>
</font>
</dt>
<dd>
<font face="arial,helvetica,sans serif">
The number of bytes written to the buffer (terminator included).
</font>
</dd>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-int_(*conninfo)">
<font size="+1" face="arial,helvetica,sans serif">
<b>int (*conninfo)</b>
</font>
<dl>
<dt><code>int (*conninfo)(wa_connection *conn, char *buf, int len);</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
Describe the configuration member found in a connection.
</font>
</dt>
<dt>
<font face="arial,helvetica,sans serif">
<b>Parameters</b>
</font>
</dt>
<dd>
<code>conn</code> -
<font face="arial,helvetica,sans serif">
The connection for wich a description must be produced.
</font>
</dd>
<dd>
<code>buf</code> -
<font face="arial,helvetica,sans serif">
The buffer where the description must be stored.
</font>
</dd>
<dd>
<code>len</code> -
<font face="arial,helvetica,sans serif">
The buffer length.
</font>
</dd>
<dt>
<font face="arial,helvetica,sans serif">
<b>Return Value</b>
</font>
</dt>
<dd>
<font face="arial,helvetica,sans serif">
The number of bytes written to the buffer (terminator included).
</font>
</dd>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-void_(*handle)">
<font size="+1" face="arial,helvetica,sans serif">
<b>void (*handle)</b>
</font>
<dl>
<dt><code>void (*handle)(wa_request *req);</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
Handle a connection from the web server.
</font>
</dt>
<dt>
<font face="arial,helvetica,sans serif">
<b>Parameters</b>
</font>
</dt>
<dd>
<code>req</code> -
<font face="arial,helvetica,sans serif">
The request data.
</font>
</dd>
</dl>
</dd>
</dl>
<hr>
<table width="100%" cellspacing="0" cellpadding="2" border="1">
<tr>
<td bgcolor="eeeeff" align="left">
<font face="arial,helvetica,sans serif">
<b>Class "wa_provider" Variables:</b>
</font>
</td>
</tr>
</table>
<a name="wa_provider-desc">
<font size="+1" face="arial,helvetica,sans serif">
<b>desc</b>
</font>
<dl>
<dt><code> const char *desc;</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
The description of this provider.
</font>
</dt>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-name">
<font size="+1" face="arial,helvetica,sans serif">
<b>name</b>
</font>
<dl>
<dt><code> const char *name;</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
The name of this provider.
</font>
</dt>
</dl>
</dd>
</dl>
<hr>
<a name="wa_provider-vers">
<font size="+1" face="arial,helvetica,sans serif">
<b>vers</b>
</font>
<dl>
<dt><code> const char *vers;</code></dt>
<dd>
<dl>
<dt>
<font face="arial,helvetica,sans serif">
The version of this provider.
</font>
</dt>
</dl>
</dd>
</dl>
<hr>
<font size="-2" face="arial,helvetica,sans serif">
<div align="center">
Copyright © 2001, The Apache Software Foundation.<br>
All Rights Reserved.<br>
Generated with <a href="http://scandoc.sourceforge.net/";>ScanDoc
0.12</a> on Thu May 10 7:37:11 2001
</div>
</font>
</body>
</html>
1.1
jakarta-tomcat-4.0/connectors/docs/api/pkg.connection_provider.html
Index: pkg.connection_provider.html
===================================================================
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; iso-8859-1">
<title>WebApp Library - Packages List</title>
</head>
<body link="#0000ff" vlink="#0000ff" alink="#0000ff"
bgcolor="#ffffff" text="#000000">
<font size="+1" face="arial,helvetica,sans serif">
<nobr><b><a href="doc.connection_provider.html" target="doc">Connection
Provider</a> package:</b></nobr>
</font>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="10"> </td>
<td> </td>
</tr>
<tr>
<td colspan="2">
<font face="arial,helvetica,sans serif">
<nobr>Classes:</nobr>
</font>
</td>
</tr>
<tr>
<td width="10"> </td>
<td>
<font face="arial,helvetica,sans serif">
<nobr><a href="doc.connection_provider.html#wa_provider"
target="doc">struct wa_provider</a></nobr>
</font>
</td>
</tr>
<tr>
<td colspan="2">
<font face="arial,helvetica,sans serif">
<nobr><i>No Global Functions defined.</i></nobr>
</font>
</td>
</tr>
<tr>
<td colspan="2">
<font face="arial,helvetica,sans serif">
<nobr><i>No Global Variables defined.</i></nobr>
</font>
</td>
</tr>
</table>
<hr>
<font size="-2" face="arial,helvetica,sans serif">
<div align="center">
Copyright © 2001, The Apache Software Foundation.<br>
All Rights Reserved.<br>
</div>
</font>
</body>
</html>
