coar 00/09/26 19:11:53
Modified: apidoc APIdict.pm TODO api.list
Log:
Some more examples recorded, and some more aspects of the API
added to the list..
Revision Changes Path
1.2 +1 -1 httpd-docs-1.3/apidoc/APIdict.pm
Index: APIdict.pm
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/APIdict.pm,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -u -r1.1 -r1.2
--- APIdict.pm 2000/09/18 01:58:01 1.1
+++ APIdict.pm 2000/09/27 02:11:52 1.2
@@ -107,7 +107,7 @@
sub define_cell {
my($self, @args) = @_;
- return &make_entry('C', @args);
+ return &make_entry('D', @args);
}
sub define_constant {
1.14 +20 -39 httpd-docs-1.3/apidoc/TODO
Index: TODO
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/TODO,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -u -r1.13 -r1.14
--- TODO 2000/09/22 23:00:54 1.13
+++ TODO 2000/09/27 02:11:52 1.14
@@ -85,45 +85,6 @@
BUFF
The following items need examples:
- ap_bspawn_child
- ap_bvputs
- ap_bwrite
- ap_bytes_in_free_blocks
- ap_bytes_in_pool
- ap_call_exec
- ap_can_exec
- ap_cfg_closefile
- ap_cfg_getc
- ap_cfg_getline
- ap_chdir_file
- ap_checkmask
- ap_check_alarm
- ap_check_cmd_context
- ap_child_exit_modules
- ap_child_init_modules
- ap_cleanup_for_exec
- ap_clear_module_list
- ap_clear_pool
- ap_clear_table
- ap_close_piped_log
- ap_construct_server
- ap_construct_url
- ap_content_type_tolower
- ap_copy_array
- ap_copy_array_hdr
- ap_copy_table
- ap_core_reorder_directories
- ap_count_dirs
- ap_create_environment
- ap_create_per_dir_config
- ap_create_request_config
- ap_daemons_limit
- ap_daemons_max_free
- ap_daemons_min_free
- ap_daemons_to_start
- ap_default_port_for_request
- ap_default_port_for_scheme
- ap_default_type
ap_destroy_pool
ap_die
ap_each_byterange
@@ -183,6 +144,7 @@
ap_init_virtual_host
ap_internal_redirect
ap_internal_redirect_handler
+ ap_is_default_port
ap_is_directory
ap_is_fnmatch
ap_is_matchexp
@@ -390,15 +352,24 @@
command_rec
configfile_t
conn_rec
+ DEFAULT_HTTPS_PORT
+ DEFAULT_HTTP_PORT
ebcdic2ascii
FNM_CASE_BLIND
FNM_NOESCAPE
FNM_NOMATCH
FNM_PATHNAME
FNM_PERIOD
+ GLOBAL_ONLY
HANDLE
HTTP_VERSION
MODULE_MAGIC_AT_LEAST
+ NOT_IN_DIRECTORY
+ NOT_IN_DIR_LOC_FILE
+ NOT_IN_FILES
+ NOT_IN_LIMIT
+ NOT_IN_LOCATION
+ NOT_IN_VIRTUALHOST
opendir
os_spawnle
os_spawnv
@@ -535,6 +506,7 @@
ap_init_vhost_config
ap_init_virtual_host
ap_invoke_handler
+ ap_is_default_port
ap_is_fnmatch
ap_is_initial_req
ap_limit_section
@@ -711,6 +683,8 @@
DECLINE_CMD
DEFAULT_ADMIN
DEFAULT_CONTENT_TYPE
+ DEFAULT_HTTPS_PORT
+ DEFAULT_HTTP_PORT
DEFAULT_KEEPALIVE
DEFAULT_KEEPALIVE_TIMEOUT
DEFAULT_PATH
@@ -721,6 +695,7 @@
FNM_NOMATCH
FNM_PATHNAME
FNM_PERIOD
+ GLOBAL_ONLY
HTTP_EXPECTATION_FAILED
HTTP_FAILED_DEPENDENCY
HTTP_INSUFFICIENT_STORAGE
@@ -742,6 +717,12 @@
M_PATCH
M_PROPFIND
M_UNLOCK
+ NOT_IN_DIRECTORY
+ NOT_IN_DIR_LOC_FILE
+ NOT_IN_FILES
+ NOT_IN_LIMIT
+ NOT_IN_LOCATION
+ NOT_IN_VIRTUALHOST
opendir
OPT_ALL
OPT_EXECCGI
1.34 +162 -61 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.33
retrieving revision 1.34
diff -u -u -r1.33 -r1.34
--- api.list 2000/09/22 23:00:54 1.33
+++ api.list 2000/09/27 02:11:53 1.34
@@ -656,7 +656,7 @@
|
R|ap_close_piped_log\
|void $*(piped_log *plp);\
- |\
+ |<i>No examples available; not used in Apache 1.3.</i>\
|SA-piped-log\
|
R|ap_open_piped_log\
@@ -667,8 +667,10 @@
#;
R|ap_content_type_tolower\
|void $*(char *str)\
+ |tmp = ap_pstrdup(r->pool, l);\n\
+$*(tmp);\n\
+r->content_type = tmp;\
|\
- |\
|
#;
#; Core records and data structures
@@ -1084,12 +1086,16 @@
|<dict-$*.html
R|ap_clear_table\
|void $*(table *t);\
- |\
+ |table tmp;\n\
+tmp = r->headers_out;\n\
+r->headers_out = r->err_headers_out;\n\
+r->err_headers_out = tmp;\n\
+$*(r->err_headers_out);\
|SA-tables\
|<dict-$*.html
R|ap_copy_table\
|table *$*(pool *p, const table *t);\
- |\
+ |rnew->subprocess_env = $*(rnew->pool, r->subprocess_env);\
|SA-tables\
|<dict-$*.html
R|ap_make_table\
@@ -1199,12 +1205,12 @@
|<dict-$*.html
R|ap_copy_array\
|array_header *$*(pool *p, const array_header *src);\
- |\
+ |<i>No examples available; not used in Apache 1.3.</i>\
|SA-array\
|<dict-$*.html
R|ap_copy_array_hdr\
|array_header *$*(pool *p, const array_header *src);\
- |\
+ |<i>No examples available; not used in Apache 1.3.</i>\
|SA-array\
|<dict-$*.html
R|ap_make_array\
@@ -1255,12 +1261,13 @@
|<dict-$*.html
R|ap_bytes_in_pool\
|long $*(pool *p);\
- |\
+ |<i>No examples available; not used in Apache 1.3.</i>\
|SA-pool\
|<dict-$*.html
R|ap_clear_pool\
|void $*(struct pool *a);\
- |\
+ |$*(plog);\n\
+ap_open_logs(server_conf, plog);\
|SA-pool\
|<dict-$*.html
R|ap_find_pool\
@@ -1755,7 +1762,7 @@
,ap_bnonblock,ap_bspawn_child\
,B_SFIO,B_RD,B_WR,B_RDWR,B_EOF,B_EOUT,B_RDERR,B_WRERR,B_ERROR\
,B_CHUNK,B_SAFEREAD,B_SOCKET,B_ASCII2EBCDIC,B_EBCDIC2ASCII\
- ,BO_BYTECT\
+ ,BO_BYTECT,kill_conditions\
|\
|\
|
@@ -2007,52 +2014,71 @@
void *data, enum kill_conditions kill_how, \n \
BUFF **pipe_in, BUFF **pipe_out, \
BUFF **pipe_err);\
- |\
+ |if (! $*(r->pool, include_cmd_child, &arg,\n\
+ kill_after_timeout, NULL, &script_in, NULL)) {\n\
+ /* Log an error */\n\
+}\
|SA-BUFF\
|
R|ap_bvputs\
|int $*(BUFF *fb, ...);\
- |\
+ |if (parm->cache != NULL\n\
+ &&parm->cache-> != NULL\n\
+ &&$*(parm->cache->fp, key, ": ", value, CRLF, NULL) == -1)
{\n\
+ /* Log an error */\n\
+}\
|\
|
R|ap_bwrite\
|int $*(BUFF *fb, const void *buf, int nbyte);\
- |\
+ |ap_reset_timeout(r);\n\
+if ($*(script_out, argsbuffer, len_read) < len_read) {\n\
+ / * silly script stopped reading, soak up remaining message */\n\
+}\
|\
|
R|ap_bytes_in_free_blocks\
|long $*(void);\
- |\
- |\
+ |<i>No examples available; not used in Apache 1.3.</i>\
+ |SA-pool\
|<dict-$*.html
R|ap_call_exec\
|int $*(request_rec *r, char *argv0, char **env, int shellcmd);\
+ |child_pid = $*(r, pinfo, argv0, env, 0);\
|\
- |\
|<dict-$*.html
R|ap_can_exec\
|int $*(const struct stat *fstat);\
- |\
+ |if (! $*(&r->finfo)) {\n\
+ /* log an error; we can't execute the file */\n\
+}\
|\
|<dict-$*.html
-R|ap_cfg_closefile\
- |int $*(configfile_t *fp);\
+X|SA-cfgfiles\
+ |ap_cfg_closefile,ap_cfg_getc,ap_cfg_getline\
|\
|\
+ |
+R|ap_cfg_closefile\
+ |int $*(configfile_t *fp);\
+ |$*(imap); /* we are done with the map file; close it */\
+ |SA-cfgfiles\
|<dict-$*.html
R|ap_cfg_getc\
|int $*(configfile_t *cfp);\
- |\
- |\
+ |<i>No examples available; not used in Apache 1.3.</i>\
+ |SA-cfgfiles\
|<dict-$*.html
R|ap_cfg_getline\
|int $*(char *buf, size_t bufsize, configfile_t *cfp);\
- |\
- |\
+ |while (! $*(l, MAX_STRING_LEN, cmd->config_file)) {\n\
+ /* Do something with the line read into l */\n\
+}\
+ |SA-cfgfiles\
|<dict-$*.html
R|ap_chdir_file\
|void $*(const char *file);\
- |\
+ |$*(r->filename);\
|\
|<dict-$*.html
R|ap_check_access\
@@ -2062,7 +2088,9 @@
|
R|ap_check_alarm\
|int $*(void);\
- |\
+ |if (! (tv.tv_sec = $*())) {\n\
+ return (send(sock, buf, len, flags));\n\
+}\
|\
|
R|ap_check_auth\
@@ -2072,7 +2100,11 @@
|
R|ap_check_cmd_context\
|const char *$*(cmd_parms *cmd, unsigned forbidden);\
- |\
+ |const char *err;\n\
+err = $*(cmd, GLOBAL_ONLY);\n\
+if (err != NULL) {\n\
+ return err;\n\
+}\
|\
|
R|ap_check_user_id\
@@ -2082,17 +2114,22 @@
|
R|ap_checkmask\
|int $*(const char *data, const char *mask);\
- |\
+ |if ($*(date, "## @$$ #### ##:##:## *")) {\n\
+ /* Date is in RFC 1123 format. */\n\
+}\
|\
|
R|ap_child_exit_modules\
|void $*(pool *p, server_rec *s);\
- |\
+ |if (pchild) {\n\
+ $*(pchild, server_conf);\n\
+ ap_destroy_pool(pchild);\n\
+}\
|\
|
R|ap_child_init_modules\
|void $*(pool *p, server_rec *s);\
- |\
+ |$*(pconf, server_conf);\
|\
|
R|ap_child_terminate\
@@ -2102,63 +2139,71 @@
|
R|ap_cleanup_for_exec\
|void $*(void);\
+ |$();\n\
+child_pid = ap_call_exec(r, pinfo, argv0, env, 0);\
|\
- |\
|<dict-$*.html
R|ap_clear_module_list\
|void $*(void);\
- |\
+ |$*();\
|\
|
R|ap_construct_server\
|char *$*(pool *p, const char *hostname, unsigned port, \
const request_rec *r);\
- |\
+ |<i>No examples available; not used in Apache 1.3.</i>\
|\
|<dict-$*.html
R|ap_construct_url\
|char *$*(pool *p, const char *uri, const request_rec *r);\
- |\
+ |return $*(r->pool, r->uri, r);\
|\
|<dict-$*.html
R|ap_core_reorder_directories\
|void $*(pool *, server_rec *);\
+ |/* XXX: this is really something that should be dealt with by a\n\
+ * post-config api phase */\n\
+$*(p, virt);\
|\
- |\
|
R|ap_count_dirs\
|int $*(const char *path);\
- |\
+ |ap_no2slash(test_filename);\n\
+num_dirs = $*(test_filename);\
|\
|<dict-$*.html
R|ap_create_environment\
|char **$*(pool *p, table *t);\
- |\
+ |ap_add_cgi_vars(r);\n\
+env = $*(r->pool, r->subprocess_env);\n\
+child_pid = ap_call_exec(r, pinfo, s, env), 1);\
|\
|
R|ap_create_per_dir_config\
|void *$*(pool *p);\
+ |void *new_file_conf;\n\
+new_file_conf = $(cmd->pool);\
|\
- |\
|
R|ap_create_request_config\
|void *$*(pool *p);\
- |\
+ |r->request_config = $*(r->pool);\
|\
|
R|ap_default_port_for_request\
|unsigned short $*(const request_rec *r);\
- |\
+ |port = (r->parsed_uri.port != 0)\n\
+ ? r->parsed_uri.port : $(r);\
|\
|
R|ap_default_port_for_scheme\
|unsigned short $*(const char *scheme_str);\
+ |uptr->port = uptr->scheme ? $(uptr->scheme) :
DEFAULT_HTTP_PORT;\
|\
- |\
|
R|ap_default_type\
|char *$*(request_req *r);\
- |\
+ |type = (r->content_type == NULL) ? $*(r) : r->content_type;\
|\
|
R|ap_destroy_sub_req\
@@ -3989,87 +4034,87 @@
#;
#; Definitions added by APIdict at 2000-09-15 23:32
#;
-C|ap_daemons_limit\
+D|ap_daemons_limit\
|int $*;\
- |\
+ |$* = HARD_SERVER_LIMIT;\
|\
|
-C|ap_daemons_max_free\
+D|ap_daemons_max_free\
|int $*;\
+ |$* = DEFAULT_MAX_FREE_DAEMON\
|\
- |\
|
-C|ap_daemons_min_free\
+D|ap_daemons_min_free\
|int $*;\
- |\
+ |$* = DEFAULT_MIN_FREE_DAEMON\
|\
|
-C|ap_daemons_to_start\
+D|ap_daemons_to_start\
|int $*;\
- |\
+ |$* = DEFAULT_START_DAEMON\
|\
|
-C|ap_excess_requests_per_child\
+D|ap_excess_requests_per_child\
|int $*;\
|\
|\
|
-C|ap_extended_status\
+D|ap_extended_status\
|int $*;\
|\
|\
|
-C|ap_group_id\
+D|ap_group_id\
|gid_t $*;\
|\
|\
|
-C|ap_loaded_modules\
+D|ap_loaded_modules\
|module **$*;\
|\
|\
|
-C|ap_max_requests_per_child\
+D|ap_max_requests_per_child\
|int $*;\
|\
|\
|
-C|ap_my_generation\
+D|ap_my_generation\
|ap_generation_t volatile $*;\
|\
|\
|
-C|ap_pid_fname\
+D|ap_pid_fname\
|char *$*;\
|\
|\
|
-C|ap_scoreboard_fname\
+D|ap_scoreboard_fname\
|char *$*;\
|\
|\
|
-C|ap_server_confname\
+D|ap_server_confname\
|char $*[MAX_STRING_LEN];\
|\
|\
|
-C|ap_standalone\
+D|ap_standalone\
|int $*;\
|\
|\
|
-C|ap_threads_per_child\
+D|ap_threads_per_child\
|int $*;\
|\
|\
|
-C|ap_user_id\
+D|ap_user_id\
|uid_t $*;\
|\
|\
|
-C|ap_user_name\
+D|ap_user_name\
|char *$*;\
|\
|\
@@ -4396,6 +4441,62 @@
|
R|regfree\
|void $*(regex_t *);\
+ |\
+ |\
+ |
+X|SA-context\
+ |NOT_IN_VIRTUALHOST,NOT_IN_LIMIT,NOT_IN_DIRECTORY,NOT_IN_LOCATION\
+ ,NOT_IN_FILES,NOT_IN_DIR_LOC_FILE,GLOBAL_ONLY\
+ |\
+ |\
+ |
+C|NOT_IN_VIRTUALHOST\
+ |#define $* <var>value</var>\
+ |\
+ |SA-context\
+ |
+C|NOT_IN_LIMIT\
+ |#define $* <var>value</var>\
+ |\
+ |SA-context\
+ |
+C|NOT_IN_DIRECTORY\
+ |#define $* <var>value</var>\
+ |\
+ |SA-context\
+ |
+C|NOT_IN_LOCATION\
+ |#define $* <var>value</var>\
+ |\
+ |SA-context\
+ |
+C|NOT_IN_FILES\
+ |#define $* <var>value</var>\
+ |\
+ |SA-context\
+ |
+C|NOT_IN_DIR_LOC_FILE\
+ |#define $* <var>value</var>\
+ |\
+ |SA-context\
+ |
+C|GLOBAL_ONLY\
+ |#define $* <var>value</var>\
+ |\
+ |SA-context\
+ |
+C|DEFAULT_HTTP_PORT\
+ |#define $* 80\
+ |\
+ |\
+ |
+C|DEFAULT_HTTPS_PORT\
+ |#define $* 443\
+ |\
+ |\
+ |
+M|ap_is_default_port\
+ |#define $*(port,r) ((port) == ap_default_port(r))\
|\
|\
|
