User manual REDHAT NETSCAPE ENTERPRISE SERVER 6.0 NSAPI PROGRAMMER GUIDE

[. . . ] NSAPI Programmer's Guide Netscape Enterprise Server Version 6. 0 November 2001 Netscape Communications Corporation ("Netscape") and its licensors retain all ownership rights to the software programs offered by Netscape (referred to herein as "Software") and related documentation. Use of the Software and related documentation is governed by the license agreement for the Software and applicable copyright law. Making unauthorized copies, adaptations or compilation works is prohibited and constitutes a punishable violation of the law. Netscape may revise this documentation from time to time without notice. [. . . ] Example if (param_free(pblock_remove("content-type", rq-srvhdrs))) return; /* we removed it */ See also param_create, pblock_pinsert, pblock_remove pblock_copy The pblock_copy function copies the entries of the source pblock and adds them into the destination pblock. Any previous entries in the destination pblock are left intact. Syntax void pblock_copy(pblock *src, pblock *dst); Returns void Parameters pblock *src is the source pblock. pblock *dst is the destination pblock. Names and values are newly allocated so that the original pblock may be freed, or the new pblock changed without affecting the original pblock. See also pblock_create, pblock_dup, pblock_free, pblock_find, pblock_findval, pblock_remove, pblock_nvinsert pblock_create The pblock_create function creates a new pblock. The pblock maintains an internal hash table for fast name-value pair lookups. Syntax pblock *pblock_create(int n); Chapter 5 NSAPI Function Reference 155 NSAPI Functions (in Alphabetical Order) Returns A pointer to a newly allocated pblock. Parameters int n is the size of the hash table (number of name-value pairs) for the pblock. See also pblock_copy, pblock_dup, pblock_find, pblock_findval, pblock_free, pblock_nvinsert, pblock_remove pblock_dup The pblock_dup function duplicates a pblock. It is equivalent to a sequence of pblock_create and pblock_copy. Syntax pblock *pblock_dup(pblock *src); Returns A pointer to a newly allocated pblock. Parameters pblock *src is the source pblock. See also pblock_create, pblock_find, pblock_findval, pblock_free, pblock_find, pblock_remove, pblock_nvinsert pblock_find The pblock_find function finds a specified name-value pair entry in a pblock, and returns the pb_param structure. If you only want the value associated with the name, use the pblock_findval function. This function is implemented as a macro. Syntax pb_param *pblock_find(char *name, pblock *pb); Returns A pointer to the pb_param structure, if one was found or NULL if name was not found. 156 Netscape Enterprise Server NSAPI Programmer's Guide · November 2001 NSAPI Functions (in Alphabetical Order) Parameters char *name is the name of a name-value pair. See also pblock_copy, pblock_dup, pblock_findval, pblock_free, pblock_nvinsert, pblock_remove pblock_findval The pblock_findval function finds the value of a specified name in a pblock. If you just want the pb_param structure of the pblock, use the pblock_find function. If you want to modify it, do a STRDUP and modify the copy. Syntax char *pblock_findval(char *name, pblock *pb); Returns A string containing the value associated with the name or NULL if no match was found Parameters char *name is the name of a name-value pair. See also pblock_create, pblock_copy, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, request_header pblock_free The pblock_free function frees a specified pblock and any entries inside it. If you want to save a variable in the pblock, remove the variable using the function pblock_remove and save the resulting pointer. Syntax void pblock_free(pblock *pb); Chapter 5 NSAPI Function Reference 157 NSAPI Functions (in Alphabetical Order) Returns void Parameters pblock *pb is the pblock to be freed. See also pblock_copy, pblock_create, pblock_dup, pblock_find, pblock_findval, pblock_nvinsert, pblock_remove pblock_nninsert The pblock_nninsert function creates a new entry with a given name and a numeric value in the specified pblock. The name and value parameters are copied. Syntax pb_param *pblock_nninsert(char *name, int value, pblock *pb); Returns A pointer to the new pb_param structure. Parameters char *name is the name of the new entry. If the value you assign is not a number, then instead use the function pblock_nvinsert to create the parameter. See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock pblock_nvinsert The pblock_nvinsert function creates a new entry with a given name and character value in the specified pblock. The name and value parameters are copied. Syntax pb_param *pblock_nvinsert(char *name, char *value, pblock *pb); 158 Netscape Enterprise Server NSAPI Programmer's Guide · November 2001 NSAPI Functions (in Alphabetical Order) Returns A pointer to the newly allocated pb_param structure Parameters char *name is the name of the new entry. Example pblock_nvinsert("content-type", "text/html", rq->srvhdrs); See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nninsert, pblock_remove, pblock_str2pblock pblock_pb2env The pblock_pb2env function copies a specified pblock into a specified environment. The function creates one new environment entry for each name-value pair in the pblock. Use this function to send pblock entries to a program that you are going to execute. Syntax char **pblock_pb2env(pblock *pb, char **env); Returns A pointer to the environment. Parameters pblock *pb is the pblock to be copied. [. . . ] This way the plugin does the cache refresh management actively by itself. Syntax PRInt32 dr_cache_refresh(DrHdl hdl, const char *key, PRUint32 klen, PRIntervalTime timeout, Entry *entry, Request *rq, Session *sn); Returns 1 if successful. Parameters DrHdl hdl is a persistent handle created by the dr_cache_init function. If a value of 0 is passed, the maxAge value passed to dr_cache_init is used. Example Entry entry; char *key = "MOVIES" GenNewMovieList(&entry. data, &entry. dataLen); // Implemented by // plugin developer if(!dr_cache_refresh(hdl, key, strlen(key), 0, &entry, rq, sn)) { ereport(LOG_FAILURE, "dr_cache_refresh() failed"); return REQ_ABORTED; } dr_net_write The dr_net_write function sends a response back to the requestor after constructing the full page with hdr, the content of the cached entry as the body (located using the key), and ftr. [. . . ]