coar 00/07/27 03:07:05 Modified: apidoc TODO api-dict.html api.list dict-DOCUMENT_LOCATION.html dict-HARD_SERVER_LIMIT.html dict-ap_table_add.html dict-ap_table_addn.html dict-ap_table_set.html dict-ap_table_setn.html mkapidict Log: Label the documentation as being strictly for 1.3, and update some of it to be more complete and useful. Revision Changes Path 1.6 +0 -2 httpd-docs-1.3/apidoc/TODO Index: TODO =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/TODO,v retrieving revision 1.5 retrieving revision 1.6 diff -u -u -r1.5 -r1.6 --- TODO 2000/07/25 21:45:46 1.5 +++ TODO 2000/07/27 10:06:53 1.6 @@ -1,5 +1,4 @@ The following need to be added to api.list: -DEFAULT_ADMIN TARGET HTTP_VERSION HTTP_VERSION_MAJOR @@ -10,7 +9,6 @@ DEFAULT_TIMEOUT DEFAULT_KEEPALIVE_TIMEOUT DEFAULT_KEEPALIVE -HARD_SERVER_LIMIT APLOG_LEVELMASK APLOG_WIN32ERROR REQUEST_NO_BODY 1.7 +4 -3 httpd-docs-1.3/apidoc/api-dict.html Index: api-dict.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/api-dict.html,v retrieving revision 1.6 retrieving revision 1.7 diff -u -u -r1.6 -r1.7 --- api-dict.html 2000/06/14 10:37:25 1.6 +++ api-dict.html 2000/07/27 10:06:54 1.7 @@ -2,7 +2,7 @@ "http://www.w3.org/TR/REC-html40/loose.dtd"> - Apache Web server API Dictionary + Apache Web server 1.3 API Dictionary @@ -14,12 +14,13 @@ alink="#ff0000" > -

Apache Web server API Dictionary

+

Apache Web server 1.3 API Dictionary

The intent of this and the related pages is to provide definitive documentation for the Apache Web server API (application programming - interface). Unfortunately, it does not yet live up to that intention, + interface) for version 1.3. Unfortunately, it does not yet live + up to that intention, but it's something, anyway. This file is under construction. 1.22 +25 -18 httpd-docs-1.3/apidoc/api.list Index: api.list =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/api.list,v retrieving revision 1.21 retrieving revision 1.22 diff -u -u -r1.21 -r1.22 --- api.list 2000/07/25 21:45:47 1.21 +++ api.list 2000/07/27 10:06:54 1.22 @@ -940,7 +940,8 @@ #; Random constants #; X|CTCEs\ - |BIG_SECURITY_HOLE,DOCUMENT_LOCATION,DYNAMIC_MODULE_LIMIT,HTTPD_ROOT\ + |BIG_SECURITY_HOLE,DEFAULT_ADMIN,DOCUMENT_LOCATION,DYNAMIC_MODULE_LIMIT\ + ,HARD_SERVER_LIMIT,HTTPD_ROOT\ |\ |\ | @@ -949,16 +950,27 @@ |env CFLAGS="-Wall -D$*" ./configure\ |CTCEs\ |dict-$*.html -C|DOCUMENT_LOCATION\ +C|DEFAULT_ADMIN\ |Compile-time definition\ |env CFLAGS="-Wall -D$*=\"/usr/httpd/htdocs\"" ./configure\ |CTCEs\ |dict-$*.html +C|DOCUMENT_LOCATION\ + |Compile-time definition\ + |env CFLAGS="-Wall -D$*=\"/usr/httpd/htdocs\"" ./configure\ + |CTCEs,ap_document_root\ + |dict-$*.html C|DYNAMIC_MODULE_LIMIT\ |Compile-time definition\ |env CFLAGS="-Wall -D$*=64" ./configure\ |CTCEs\ |dict-$*.html +C|HARD_SERVER_LIMIT\ + |Compile-time definition\ + |env CFLAGS="-Wall -D$*=1024" ./configure \n \n \ +for (i = 0; i < $*; ++i) {\n ...per-child processing...\n}\ + |CTCEs\ + |dict-$*.html C|HTTPD_ROOT\ |Compile-time definition\ |env CFLAGS="-Wall -D$*=\"/usr/httpd\"" ./configure\ @@ -1003,12 +1015,12 @@ |SA-tables\ |dict-$*.html R|ap_table_add\ - |void $*(table *t, const char *key, const char *val);\ + |void $*(table *t, const char *k, const char *val);\ |\ |SA-tables\ |dict-$*.html R|ap_table_addn\ - |void $*(table *t, const char *key, const char *val);\ + |void $*(table *t, const char *k, const char *val);\ |\ |SA-tables\ |dict-$*.html @@ -1016,7 +1028,7 @@ #; Here's an example of multiline definition with proper indenting. #; R|ap_table_do\ - |void $*(int (*comp) (void *d, const char *key, const char *val), \n \ + |void $*(int (*comp) (void *d, const char *k, const char *val), \n \ void *rec, const table *t, ...);\ |\ |SA-tables\ @@ -1027,27 +1039,27 @@ |SA-tables\ |dict-$*.html R|ap_table_merge\ - |void $*(table *tab, const char *name, const char *more_val);\ + |void $*(table *t, const char *k, const char *more_val);\ |\ |SA-tables\ |dict-$*.html R|ap_table_mergen\ - |void $*(table *tab, const char *name, const char *more_val);\ + |void $*(table *t, const char *k, const char *more_val);\ |\ |SA-tables\ |dict-$*.html R|ap_table_set\ - |void $*(table *tab, const char *name, const char *val);\ + |void $*(table *t, const char *k, const char *val);\ |\ |SA-tables\ |dict-$*.html R|ap_table_setn\ - |void $*(table *tab, const char *name, const char *val);\ + |void $*(table *t, const char *k, const char *val);\ |\ |SA-tables\ |dict-$*.html R|ap_table_unset\ - |void $*(table *tab, const char *key);\ + |void $*(table *t, const char *k);\ |\ |SA-tables\ |dict-$*.html @@ -1889,9 +1901,9 @@ |\ |dict-$*.html R|ap_document_root\ - |char *$*(request_rec *r);\ - |\ - |\ + |const char *$*(request_rec *r);\ + |request_rec *r;\nconst char *docroot;\ndocroot = ap_document_root(r)\n \ + |DOCUMENT_LOCATION\ |dict-$*.html R|ap_each_byterange\ |int $*(request_rec *r, long *offset, long *length);\ @@ -2945,11 +2957,6 @@ C|SERVER_VERSION\ |#define $* string\ |Deprecated; use ap_get_server_version() instead.\ - |\ - |dict-$*.html -C|HARD_SERVER_LIMIT\ - |#define $* value\ - |for (i = 0; i < $*; ++i) {\n ...per-child processing...\n}\ |\ |dict-$*.html C|kill_conditions\ 1.2 +5 -0 httpd-docs-1.3/apidoc/dict-DOCUMENT_LOCATION.html Index: dict-DOCUMENT_LOCATION.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-DOCUMENT_LOCATION.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -u -r1.1 -r1.2 --- dict-DOCUMENT_LOCATION.html 2000/07/23 15:32:50 1.1 +++ dict-DOCUMENT_LOCATION.html 2000/07/27 10:06:54 1.2 @@ -13,3 +13,8 @@ The default value is based on the definition of the HTTPD_ROOT compile-time definition (q.v.).

+

+You should use the ap_document_root() (q.v.) routine +instead to obtain the value of the DocumentRoot for the server handling a +request. +

\ No newline at end of file 1.3 +10 -1 httpd-docs-1.3/apidoc/dict-HARD_SERVER_LIMIT.html Index: dict-HARD_SERVER_LIMIT.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-HARD_SERVER_LIMIT.html,v retrieving revision 1.2 retrieving revision 1.3 diff -u -u -r1.2 -r1.3 --- dict-HARD_SERVER_LIMIT.html 2000/07/24 22:13:49 1.2 +++ dict-HARD_SERVER_LIMIT.html 2000/07/27 10:06:55 1.3 @@ -1,3 +1,12 @@

-The maximum possible number of server processes. +This compile-time constant defines the maximum possible number of server +processes. It places a ceiling on the number of concurrent requests +the server can handle. It is used to size several static data structures +and therefore requires a recompilation in order to change the value. +

+

+The default value for Windows is 1024, because on that platform +it refers to threads rather than processes. For all other +platforms the default value (which does refer to actual +child processes) is 256.

1.4 +19 -2 httpd-docs-1.3/apidoc/dict-ap_table_add.html Index: dict-ap_table_add.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-ap_table_add.html,v retrieving revision 1.3 retrieving revision 1.4 diff -u -u -r1.3 -r1.4 --- dict-ap_table_add.html 2000/07/24 22:14:00 1.3 +++ dict-ap_table_add.html 2000/07/27 10:06:55 1.4 @@ -1,6 +1,23 @@

-Adds a new value val to t, associated with key. +Adds a new value val to table t, associated with key +key. +Both the key and the value are copied into the table's pool using +ap_pstrdup() and pointers to the copies used in the table. +If both values are constants, such +as literal strings, you should use ap_table_addn() +instead.

-A new table entry is always created, even if it duplicates another. +A new table entry is always created, even if there are already one or +more entries with the same key. +To update an existing entry, or create it if it doesn't exist, use +ap_table_set() (q.v.). Be aware, though, +that ap_table_set() will delete all other entries +with the same key. +

+

+If a table has multiple entries for a particular key, only the +first will be returned by the direct lookup routines (e.g., +ap_table_get()). The only way to access such duplicate +entries is to traverse the table with ap_table_do().

1.5 +14 -2 httpd-docs-1.3/apidoc/dict-ap_table_addn.html Index: dict-ap_table_addn.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-ap_table_addn.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -u -r1.4 -r1.5 --- dict-ap_table_addn.html 2000/07/24 22:14:00 1.4 +++ dict-ap_table_addn.html 2000/07/27 10:06:55 1.5 @@ -1,7 +1,19 @@

-Adds a new value val to t, associated with key. +Adds a new value val to table t, associated with key. +Pointers to the supplied strings are stored in the table, so they +must either be constants or at least have a greater longevity than +the table's pool, and they must not be modified after the +entry has been added to the table. If these conditions cannot be +met, you should use ap_table_add() instead.

A new table entry is always created, even if it duplicates another. -This function does not use ap_pstrdup. +To update an existing entry, or create it if it doesn't exist, use +ap_table_setn(). +

+

+If a table has multiple entries for a particular key, only the +first will be returned by the direct lookup routines (e.g., +ap_table_get()). The only way to access such duplicate +entries is to traverse the table with ap_table_do().

1.4 +10 -1 httpd-docs-1.3/apidoc/dict-ap_table_set.html Index: dict-ap_table_set.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-ap_table_set.html,v retrieving revision 1.3 retrieving revision 1.4 diff -u -u -r1.3 -r1.4 --- dict-ap_table_set.html 2000/07/24 22:14:00 1.3 +++ dict-ap_table_set.html 2000/07/27 10:06:56 1.4 @@ -1,3 +1,12 @@

-Replaces or creates t with new val in table t. +Sets the entry in table t with key k to have value +val. If no such entry exists, one is created. If an +entry does exist, its value is replaced. If there are multiple +entries with key k, the first one is modified, and +all the other matching entries are deleted from the table. The value +is always duplicated from the routine argument into the table's pool +using ap_pstrdup(), and a pointer to the copy used; if a new +entry needs to be created, the key string is copied as well. If both +the key and the value are literals, use ap_table_setn() +instead.

1.5 +10 -4 httpd-docs-1.3/apidoc/dict-ap_table_setn.html Index: dict-ap_table_setn.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-ap_table_setn.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -u -r1.4 -r1.5 --- dict-ap_table_setn.html 2000/07/24 22:14:00 1.4 +++ dict-ap_table_setn.html 2000/07/27 10:06:56 1.5 @@ -1,6 +1,12 @@

-Replaces or creates t with new val in table t. -

-

-This function does not use ap_pstrdup. +Sets the entry in table t with key k to have value +val. If no such entry exists, one is created. If an +entry does exist, its value is replaced. If there are multiple +entries with key k, the first one is modified, and +all the other matching entries are deleted from the table. +The key and value pointers from the argument list are inserted +directly into the table, so the caller must not modify +them after calling this routine. If either the key or the +value cannot be guaranteed immutable, you should use +ap_table_set() (q.v.) instead.

1.15 +2 -2 httpd-docs-1.3/apidoc/mkapidict Index: mkapidict =================================================================== RCS file: /home/cvs/httpd-docs-1.3/apidoc/mkapidict,v retrieving revision 1.14 retrieving revision 1.15 diff -u -u -r1.14 -r1.15 --- mkapidict 2000/07/25 21:45:47 1.14 +++ mkapidict 2000/07/27 10:06:56 1.15 @@ -466,10 +466,10 @@ "http://www.w3.org/TR/REC-html40/loose.dtd"> - Apache API: $iname + Apache 1.3 API: $iname -

Apache API Documentation

+

Apache 1.3 API Documentation

EOHT my($p) = $Prefix{$rtype};