A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z

Index

A

about this guide  1

contents  1

other resources  1

AddLog  1

example of custom SAF  1

flow of control  1

requirements for SAFs  1, 2

summary  1

Administration interface

more information about  1

alphabetical reference

NSAPI functions  1, 2

API functions

CALLOC  1

cinfo_find  1

condvar_init  1

condvar_notify  1

condvar_terminate  1

condvar_wait  1

crit_enter  1

crit_exit  1

crit_init  1

crit_terminate  1

daemon_atrestart  1

dr_cache_init  1

dr_cache_refresh  1

dr_net_write  1

fc_close  1

fc_net_write  1

filebuf_buf2sd  1, 2

filebuf_close  1

filebuf_getc  1

filebuf_open  1

filebuf_open_nostat  1

filter_create  1

filter_find  1

filter_insert  1

filter_layer  1

filter_name  1

filter_remove  1

flush  1

FREE  1

func_exec  1

func_find  1

func_insert  1

insert  1

log_error  1

MALLOC  1

net_ip2host  1

net_read  1

net_write  1

netbuf_buf2sd  1

netbuf_close  1

netbuf_getc  1

netbuf_grab  1

netbuf_open  1

param_create  1

param_free  1

pblock_copy  1

pblock_create  1

pblock_dup  1

pblock_find  1

pblock_findval  1

pblock_free  1

pblock_nninsert  1

pblock_nvinsert  1

pblock_pb2env  1

pblock_pblock2str  1

pblock_pinsert  1

pblock_remove  1

pblock_str2pblock  1

PERM_FREE  1

PERM_MALLOC  1, 2, 3

PERM_STRDUP  1

prepare_nsapi_thread  1

protocol_dump822  1

protocol_set_finfo  1

protocol_start_response  1

protocol_status  1

protocol_uri2url  1, 2

read  1

REALLOC  1

remove  1

request_get_vs  1

request_header  1

request_stat_path  1

request_translate_uri  1

sendfile  1

session_dns  1

session_maxdns  1

shexp_casecmp  1

shexp_cmp  1

shexp_match  1

shexp_valid  1

STRDUP  1

system_errmsg  1

system_fclose  1

system_flock  1

system_fopenRO  1

system_fopenRW  1

system_fopenWA  1

system_fread  1

system_fwrite  1

system_fwrite_atomic  1

system_gmtime  1

system_localtime  1

system_lseek  1

system_rename  1

system_ulock  1, 2

system_unix2local  1

systhread_attach  1

systhread_current  1

systhread_getdata  1

systhread_newkey  1

systhread_setdata  1

systhread_sleep  1

systhread_start  1

systhread_timerset  1

util_can_exec  1

util_chdir2path  1, 2

util_cookie_find  1

util_env_find  1

util_env_free  1

util_env_replace  1

util_env_str  1

util_getline  1

util_hostname  1

util_is_mozilla  1

util_is_url  1

util_itoa  1

util_later_than  1

util_sh_escape  1

util_snprintf  1

util_strcasecmp  1

util_strftime  1

util_strncasecmp  1

util_uri_escape  1

util_uri_is_evil  1

util_uri_parse  1

util_uri_unescape  1

util_vsnprintf  1

util_vsprintf  1

util-cookie_find  1

util-sprintf  1

vs_alloc_slot  1

vs_get_data  1

vs_get_default_httpd_object  1

vs_get_doc_root  1

vs_get_httpd_objset  1

vs_get_id  1

vs_get_mime_type  1

vs_lookup_config_var  1

vs_register_cb  1

vs_set_data  1

vs_translate_uri  1

write  1

writev  1

AUTH_TYPE environment variable  1

AUTH_USER environment variable  1

AuthTrans  1

example of custom SAF  1

flow of control  1

requirements for SAFs  1, 2

summary  1

B

browsers  1

buffered streams  1

buffer-size parameter  1

buffers-per-file parameter  1

C

cache

enabling memory allocation pool  1

cache-size parameter  1

caching

results caching plugin  1

CALLOC API function  1

case sensitivity in obj.conf  1

CGI

environment variables in NSAPI  1

execution  1

to NSAPI conversion  1

cgistub-path parameter  1

chunked encoding  1, 2

cindex-init function  1

cinfo NSAPI data structure  1

cinfo_find API function  1

client

field in session parameter  1

getting DNS name for  1

getting IP address for  1

requests  1

sessions and  1

Client tag  1, 2

CLIENT_CERT environment variable  1

comments in obj.conf  1

Common Log subsystem

initializing  1

compatibility issues  1, 2

compiling custom SAFs  1

compression, HTTP  1

condvar_init API function  1

condvar_notify API function  1

condvar_terminate API function  1

condvar_wait API function  1

configuration

dynamic  1

CONTENT_LENGTH environment variable  1

CONTENT_TYPE environment variable  1

context->data  1

context->rq  1

context->sn  1

creating

custom filters  1, 2

custom SAFs  1

custom server-parsed HTML tags  1

crit_enter API function  1

crit_exit API function  1

crit_init API function  1

crit_terminate API function  1

csd field in session parameter  1

custom

filters  1, 2

SAFs  1, 2

server-parsed HTML tags  1

D

daemon_atrestart API function  1

data structures  1

cinfo  1

compatibility issues  1

Filter  1

FilterContext  1

FilterLayer  1

FilterMethods  1

nsapi.h header file  1

nsapi_pvt.h  1

pb_entry  1

pb_param  1

pblock  1

privatization of  1

removed from nsapi.h  1

request  1

sendfiledata  1

session  1

Session->client  1

shmem_s  1

stat  1

day of month  1

define-perf-bucket function  1

defining

custom SAFs  1

server-side tags  1

description parameter  1

directives

for handling requests  1

order of  1

summary for obj.conf  1

syntax in obj.conf  1

disable parameter  1, 2

DNS names

getting clients  1

dns-cache-init function  1

documentation

Sun ONE Web Server  1

dr_cache_init API function  1

dr_cache_refresh API function  1

dr_net_write API function  1

dynamic link library

loading  1

dynamic reconfiguration  1

dynamic results caching  1

E

environment variables

and init-cgi function  1

CGI to NSAPI conversion  1

env-variables parameter  1

Error directive  1

flow of control  1

requirements for SAFs  1, 2

summary  1

errors

finding most recent system error  1

examples

location in the build  1

of custom filters  1

of custom SAFs (plugins)  1

of custom SAFs in the build  1

quality of service  1

wildcard patterns  1

expire parameter  1

F

fancy indexing  1

fc_close API function  1

fc_net_write API function  1

file descriptor

closing  1

locking  1

opening read-only  1

opening read-write  1

opening write-append  1

reading into a buffer  1

unlocking  1, 2

writing from a buffer  1

writing without interruption  1

file I/O routines  1

file name extensions

object type  1

filebuf_buf2sd API function  1, 2

filebuf_close API function  1

filebuf_getc API function  1

filebuf_open API function  1

filebuf_open_nostat API function  1

filter methods  1

C prototypes for  1

FilterLayer data structure  1

flush  1

insert  1

remove  1

sendfile  1

write  1

writev  1

Filter NSAPI data structure  1

filter_create API function  1

filter_find API function  1

filter_insert API function  1

filter_layer API function  1

filter_name API function  1

filter_remove API function  1

FilterContext NSAPI data structure  1

FilterLayer NSAPI data structure  1, 2

context->data  1

context->rq  1

context->sn  1

lower  1

FilterMethods NSAPI data structure  1

filters

altering Content-length  1

creating custom  1

examples of  1

functions used to implement  1

input  1

interface  1

methods  1

NSAPI function overview  1

output  1

stack position  1

using  1

filters parameter  1

flexible logging  1

flex-init formatting  1

flex-init function  1

flex-log function  1, 2, 3

flex-rotate-init function  1

flow of control  1

flush API function  1, 2

fn argument

in directives in obj.conf  1

force-type function  1

forcing object type  1

format parameter  1

formats, time  1

forward slashes  1

FREE API function  1

free-size parameter  1

func_exec API function  1

func_find API function  1

func_insert API function  1

funcs parameter  1, 2

functions

reference  1

G

-G option  1

GATEWAY_INTERFACE environment variable  1

GMT time

getting thread-safe value  1

H

headers

field in request parameter  1

request  1

response  1

HOST environment variable  1

HTML tags

creating custom  1

HTTP

basics  1

buffered streams  1

compliance with HTTP/1.1  1

HTTP/1.1 specification  1

overview  1

registering methods  1

requests  1

responses  1

status codes  1

HTTP compression  1

HTTP_* environment variable  1

http-compression filter  1

http-decompression filter  1

HTTPS environment variable  1

HTTPS_KEYSIZE environment variable  1

HTTPS_SECRETKEYSIZE environment variable  1

I

icon-uri parameter  1

IETF home page  1

ignore parameter  1

include directory

for SAFs  1

indexing

fancy  1

Init SAFs in magnus.conf  1

requirements for SAFs  1, 2

init-cgi function  1

init-clf function  1

init-dav function  1

initializing

for CGI  1

global settings  1

plugins  1

SAFs  1

the WebDAV subsystem  1

init-uhome function  1

Input  1

flow of control  1

requirements for SAFs  1, 2

summary  1

input filters  1

insert API function  1, 2

IP address

getting client’s  1

L

LateInit parameter  1

layer parameter  1

line continuation  1

linking SAFs  1

loading

custom SAFs  1

plugins  1

SAFs  1

load-modules function  1

example  1

localtime

getting thread-safe value  1

log entries, chronological order  1

log file format  1

log_error API function  1

logFileName parameter  1, 2

logging

cookies  1

flexible  1

rotating logs  1

M

magnus.conf

about  1

SAFs in  1

Makefile file  1

MALLOC API function  1

matching

special characters  1

maxthreads parameter  1

memory allocation

pool-init function  1

memory management routines  1

methods parameter  1

minthreads parameter  1

month name  1

N

name attribute

in obj.conf objects  1

in objects  1

name parameter  1, 2

NameTrans  1

example of custom SAF  1

flow of control  1

requirements for SAFs  1, 2

summary  1

native thread pools

defining in obj.conf  1

NativeThread parameter  1, 2

net_ip2host API function  1

net_read API function  1

net_write API function  1

netbuf_buf2sd API function  1

netbuf_close API function  1

netbuf_getc API function  1

netbuf_grab API function  1

netbuf_open API function  1

network I/O routines  1

nondefault objects

processing  1

NSAPI

alphabetical function reference  1, 2

CGI environment variables  1

data structure reference  1

filter interface  1

function overview  1

NSAPI filters

interface  1

methods  1

nsapi.h  1

nsapi_pvt.h  1

nt-console-init function  1

O

obj.conf

adding directives for new SAFs  1

case sensitivity  1

Client tag  1

comments  1

directive syntax  1

directives  1

directives summary  1

flow of control  1

Object tag  1

order of directives  1

parameters for directives  1

predefined SAFs  1

processing other objects  1

server instructions  1

standard directives  1

syntax rules  1

use  1

Object tag  1

name attribute  1

ppath attribute  1

object type

forcing  1

setting by file extension  1

objects

processing nondefault objects  1

ObjectType  1

example of custom SAF  1

flow of control  1

requirements for SAFs  1, 2

summary  1

opts parameter  1

order

of directives in obj.conf  1

of filters in filter stack  1

Output  1

example of custom SAF  1

flow of control  1

requirements for SAFs  1, 2

summary  1

output filters  1

P

param_create API function  1

param_free API function  1

parameter block

manipulation routines  1

SAF parameter  1

parameters

for obj.conf directives  1

for SAFs  1

path name

converting UNIX-style to local  1

path names  1

PATH_INFO environment variable  1

PATH_TRANSLATED environment variable  1

PathCheck  1

example of custom SAF  1

flow of control  1

requirements for SAFs  1, 2

summary  1

patterns  1

pb SAF parameter  1

pb_entry NSAPI data structure  1

pb_param NSAPI data structure  1

pblock

NSAPI data structure  1

pblock_copy API function  1

pblock_create API function  1

pblock_dup API function  1

pblock_find API function  1

pblock_findval API function  1

pblock_free API function  1

pblock_nninsert API function  1

pblock_nvinsert API function  1

pblock_pb2env API function  1

pblock_pblock2str API function  1

pblock_pinsert API function  1

pblock_remove API function  1

pblock_str2pblock API function  1

perf-init function  1

PERM_FREE API function  1

PERM_MALLOC API function  1, 2, 3

PERM_STRDUP API function  1

pfx2dir function  1

plugins

compatibility issues  1, 2

creating  1

example of new plugins  1

instructing the server to use  1

loading and initializing  1

private data structures  1

pool parameter  1

pool-init function  1

ppath attribute

in obj.conf objects  1

in objects  1

predefined SAFs in obj.conf  1

preface  1

prepare_nsapi_thread API function  1

private data structures  1

processing nondefault objects  1

product support  1

profiling parameter  1

protocol utility routines  1

protocol_dump822 API function  1

protocol_set_finfo API function  1

protocol_start_response API function  1

protocol_status API function  1

protocol_uri2url API function  1, 2

pwfile parameter  1

Q

qos.c file  1

quality of service

example code  1

QUERY environment variable  1

QUERY_STRING environment variable  1

queueSize parameter  1

quotes  1

R

read API function  1, 2

REALLOC API function  1

reference

data structure  1

NSAPI functions  1

register-http-method function  1

relink_36plugin file  1

REMOTE_ADDR environment variable  1

REMOTE_HOST environment variable  1

REMOTE_IDENT environment variable  1

REMOTE_USER environment variable  1

remove API function  1, 2

replace.c  1

REQ_ABORTED response code  1

REQ_EXIT response code  1

REQ_NOACTION response code  1

REQ_PROCEED response code  1

reqpb

field in request parameter  1

request

NSAPI data structure  1

SAF parameter  1

request headers  1

request_get_vs API function  1

request_header API function  1

REQUEST_METHOD environment variable  1

request_stat_path API function  1

request_translate_uri API function  1

request-handling process  1

flow of control  1

steps  1

request-response model  1

requests

directives for handling  1

how server handles  1

HTTP  1

methods  1

steps in handling  1

requirements for SAFs  1

AddLog  1

AuthTrans  1

Error directive  1

Init  1

Input  1

NameTrans  1

ObjectType  1

Output  1

PathCheck  1

Service  1

response headers  1

responses

HTTP  1

result codes  1

results caching plugin  1

important functions used by  1

rotate-access parameter  1

rotate-callback parameter  1

rotate-error parameter  1

rotate-interval parameter  1

rotate-start parameter  1

rotating logs  1

rq SAF parameter  1

rq->headers  1

rq->reqpb  1

rq->srvhdrs  1

rq->vars  1

rules

for editing obj.conf  1

S

SAFs

compiling and linking  1

creating  1

examples of custom SAFs  1

in magnus.conf  1

include directory  1

interface  1

loading and initializing  1

parameters  1

predefined  1

result codes  1

return values  1

signature  1

testing  1

SCRIPT_NAME environment variable  1

search patterns  1

sendfile API function  1, 2

sendfiledata NSAPI data structure  1

separators  1

server

flow of control  1

initialization directives in magnus.conf  1

instructions for using plugins  1

instructions in obj.conf  1

processing nondefault objects  1

request handling  1

server.xml

variables defined in  1

SERVER_NAME environment variable  1

SERVER_PORT environment variable  1

SERVER_PROTOCOL environment variable  1

SERVER_SOFTWARE environment variable  1

SERVER_URL environment variable  1

server-parsed HTML tags

creating custom  1

more information  1

Service  1

default directive  1

directives for new SAFs (plugins)  1

example of custom SAF  1

examples  1

flow of control  1

requirements for SAFs  1, 2

summary  1

session

defined  1

NSAPI data structure  1

resolving the IP address of  1

session SAF parameter  1

Session->client NSAPI data structure  1

session_dns API function  1

session_maxdns API function  1

shared library

loading  1

shell expression

comparing (case-blind) to a string  1

comparing (case-sensitive) to a string  1, 2

validating  1

shexp_casecmp API function  1

shexp_cmp API function  1

shexp_match API function  1

shexp_valid API function  1

shlib parameter  1, 2

shmem_s NSAPI data structure  1

ShtmlTagInstanceLoad function  1

ShtmlTagInstanceUnload function  1

ShtmlTagPageLoadFunc function  1

ShtmlTagPageUnLoadFn  1

sn SAF parameter  1

sn->client  1

sn->csd  1

socket

closing  1

reading from  1

sending a buffer to  1

sending file buffer to  1

writing to  1

spaces  1

special characters  1

sprintf, see util_sprintf  1

srvhdrs

field in request parameter  1

stackSize parameter  1

stat NSAPI data structure  1

stats-init function  1

status codes  1

stderr parameter  1

stdout parameter  1

STRDUP API function  1

streams

buffered  1

string

creating a copy of  1

Sun ONE Web Server documentation  1

support  1

syntax

directives in obj.conf  1

for editing obj.conf  1

system_errmsg API function  1

system_fclose API function  1

system_flock API function  1

system_fopenRO API function  1

system_fopenRW API function  1

system_fopenWA API function  1

system_fread API function  1

system_fwrite API function  1

system_fwrite_atomic API function  1

system_gmtime API function  1

system_localtime API function  1

system_lseek API function  1

system_rename API function  1

system_ulock API function  1, 2

system_unix2local API function  1

systhread_attach API function  1

systhread_current API function  1

systhread_getdata API function  1

systhread_newkey API function  1

systhread_setdata API function  1

systhread_sleep API function  1

systhread_start API function  1

systhread_timerset API function  1

T

tags

Client  1

creating custom  1

Object  1

testing custom SAFs  1

thread

allocating a key for  1

creating  1

getting a pointer to  1

getting data belonging to  1

putting to sleep  1

setting data belonging to  1

setting interrupt timer  1

thread pools

defining in obj.conf  1

thread routines  1

thread-pool-init function  1

time formats  1

timeout parameter  1

timezones parameter  1

U

unicode  1, 2

update-interval parameter  1

URL

translated to file path  1

util_can_exec API function  1

util_chdir2path API function  1, 2

util_cookie_find API function  1

util_env_find API function  1

util_env_free API function  1

util_env_replace API function  1

util_env_str API function  1

util_getline API function  1

util_hostname API function  1

util_is_mozilla API function  1

util_is_url API function  1

util_itoa API function  1

util_later_than API function  1

util_sh_escape API function  1

util_snprintf API function  1

util_sprintf API function  1

util_strcasecmp API function  1

util_strftime API function  1, 2

util_strncasecmp API function  1

util_uri_escape API function  1

util_uri_is_evil API function  1

util_uri_parse API function  1

util_uri_unescape API function  1

util_vsnprintf API function  1

util_vsprintf API function  1

utility routines  1

V

vars

field in request parameter  1

virtual server routines  1

virtual-servers parameter  1

vs_alloc_slot API function  1

vs_get_data API function  1

vs_get_default_httpd_object API function  1

vs_get_doc_root API function  1

vs_get_httpd_objset API function  1

vs_get_id API function  1

vs_get_mime_type API function  1

vs_lookup_config_var API function  1

vs_register_cb API function  1

vs_set_data API function  1

vs_translate_uri API function  1

vsnprintf, see util_vsnprintf  1

vsprintf, see util_vsprintf  1

W

weekday  1

widths parameter  1

wildcard patterns  1

write API function  1, 2

writev API function  1, 2

Copyright 2004 Sun Microsystems, Inc. All rights reserved.