User manual REDHAT NETSCAPE ENTERPRISE SERVER 6.1 NSAPI PROGRAMMER GUIDE

[. . . ] NSAPI Programmer's Guide Netscape Enterprise Server Version 6. 1 April 2002 (Draft) 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. [. . . ] 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 161 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. pblock *pb is the pblock into which the insertion occurs. 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); 162 Netscape Enterprise Server NSAPI Programmer's Guide · April 2002 (Draft) 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. See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock pblock_pblock2str The pblock_pblock2str function copies all parameters of a specified pblock into a specified string. The function allocates additional non-heap space for the string if needed. Use this function to stream the pblock for archival and other purposes. Chapter 5 NSAPI Function Reference 163 NSAPI Functions (in Alphabetical Order) Syntax char *pblock_pblock2str(pblock *pb, char *str); Returns The new version of the str parameter. If str is NULL, this is a new string; otherwise it is a reallocated string. In either case, it is allocated from the request's memory pool. Parameters pblock *pb is the pblock to be copied. It must have been allocated by MALLOC or REALLOC, not by PERM_MALLOC or PERM_REALLOC (which allocate from the system heap). Each name-value pair in the string is separated from its neighbor pair by a space and is in the format name="value". See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock pblock_pinsert The function pblock_pinsert inserts a pb_param structure into a pblock. Syntax void pblock_pinsert(pb_param *pp, pblock *pb); Returns void Parameters pb_param *pp is the pb_param structure to insert. See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock 164 Netscape Enterprise Server NSAPI Programmer's Guide · April 2002 (Draft) NSAPI Functions (in Alphabetical Order) pblock_remove The pblock_remove function removes a specified name-value entry from a specified pblock. If you use this function you should eventually call param_free in order to deallocate the memory used by the pb_param structure. Syntax pb_param *pblock_remove(char *name, pblock *pb); Returns A pointer to the named pb_param structure, if it was found or NULL if the named pb_param was not found. Parameters char *name is the name of the pb_param to be removed. pblock *pb is the pblock from which the name-value entry is to be removed. See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, param_create, param_free pblock_str2pblock The pblock_str2pblock function scans a string for parameter pairs, adds them to a pblock, and returns the number of parameters added. Syntax int pblock_str2pblock(char *str, pblock *pb); Returns The number of parameter pairs added to the pblock, if any or -1 if an error occurred Parameters char *str is the string to be scanned. The name-value pairs in the string can have the format name=value or name="value". [. . . ] 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. [. . . ]