Netscape ENTERPRISE SERVER 6.1, Manual

Page: 117 / 373

SAF Parameters
Chapter 4 Creating Custom SAFs 117
In this case, the
pb
parameter passed to
basic-ncsa
contains name/value pairs
that correspond to
auth-type=basic
and
dbm=/netscape/servers/userdb/rs
.
NSAPI provides a set of functions for working with
pblock
data structures. For
example,
pblock_findval()
returns the value for a given name in a
pblock
. See
“Parameter Block Manipulation Routines,” on page 127 for a summary of the most
commonly used functions for working with parameter blocks.
sn (session)
The
sn
parameter is a pointer to a
Session
data structure. This parameter contains
variables related to an entire session (that is, the time between the opening and
closing of the TCP/IP connection between the client and the server). The same
sn
pointer is passed to each SAF called within each request for an entire session. The
following list describes the most important fields in this data structure.
(See Chapter 5, “NSAPI Function Reference” for information about NSAPI routines
for manipulating the
Session
data structure):
•
sn->client
is a pointer to a
pblock
containing information about the client such as its IP
address, DNS name, or certificate. If the client does not have a DNS name or if
it cannot be found, it will be set to
-none
.
•
sn->csd
is a platform-independent client socket descriptor. You will pass this to the
routines for reading from and writing to the client.
rq (request)
The
rq
parameter is a pointer to a
request
data structure. This parameter contains
variables related to the current request, such as the request headers, URI, and local
file system path. The same
request
pointer is passed to each SAF called in the
request-response process for an HTTP request.
The following list describes the most important fields in this data structure (See
Chapter 5, “NSAPI Function Reference,” for information about NSAPI routines for
manipulating the
Request
data structure).