Sun Java System Web Server 7.0 Update 3 NSAPI Developer's Guide

C

CALLOC() Macro

The CALLOC macro is a platform-independent substitute for the C library routine calloc. It allocates size bytes from the request’s memory pool and initializes the memory to zeros. The memory can be explicitly freed by a call to FREE. If the memory is not explicitly freed, it is automatically freed after processing of the current request has been completed. If pooled memory has been disabled in the configuration file with the pool-init built-in SAF, PERM-CALLOC and CALLOC both obtain their memory from the system heap. However, because memory allocated by CALLOC is automatically freed, the memory should not be shared with threads.

Syntax

void *CALLOC(int size)

Return Values

A void pointer to a block of memory.

Parameters

int size is the number of bytes to allocate.

Example

char *name;
name = (char *) CALLOC(100);

See Also

FREE() Macro, MALLOC() Macro, REALLOC() Macro, STRDUP() Macro, PERM_CALLOC() Macro

cinfo_find() Function

The cinfo_find() function uses the MIME types information to find the type, encoding, or language based on the extensions of the Universal Resource Identifier (URI) or local file name. Use this information to send headers (rq->srvhdrs) to the client indicating the content-type, content-encoding, and content-language of the data the client will be receiving from the server.

The URI name used is everything after the last slash (/) or the whole string if no slash is found. File name extensions are not case sensitive. The name can contain multiple extensions separated by a period (.) to indicate type, encoding, or language. For example, the URI a/b/filename.jp.txt.zip represents a Japanese language, text/plain type, zip-encoded file.

Syntax

cinfo *cinfo_find(char *uri);

Returns

A pointer to a newly allocated cinfo structure if the find succeeds, or NULL if the find fails.

The cinfo structure that is allocated and returned contains pointers to the content-type, content-encoding, and content-language, if found. Each structure points to static data in the types database, or NULL if not found. Do not free these pointers. You should free the cinfo structure after using it.

Parameters

char *uri is a Universal Resource Identifier (URI) or local file name. Multiple file name extensions should be separated by periods (.).

condvar_init() Function

The condvar_init function is a critical-section function that initializes and returns a new condition variable associated with a specified critical-section variable. You can use the condition variable to prevent interference between two threads of execution.

Syntax

CONDVAR condvar_init(CRITICAL id);

Return Values

A newly allocated condition variable (CONDVAR).

Parameters

CRITICAL id is a critical-section variable.

See Also

condvar_notify() Function, condvar_terminate() Function, condvar_wait() Function, crit_init() Function, crit_enter() Function, crit_exit() Function, crit_terminate() Function

condvar_notify() Function

The condvar_notify function is a critical-section function that awakens any threads that are blocked on the given critical-section variable. Use this function to awaken threads of execution of a given critical section. First, use crit_enter to gain ownership of the critical section. Then use the returned critical-section variable to call condvar_notify to awaken the threads. Finally, when condvar_notify returns, call crit_exit to surrender ownership of the critical section.

Syntax

void condvar_notify(CONDVAR cv);

Return Values

void

Parameters

CONDVAR cv is a condition variable.

See Also

condvar_init() Function, condvar_terminate() Function, condvar_wait() Function, crit_init() Function, crit_enter() Function, crit_exit() Function, crit_terminate() Function

condvar_terminate() Function

The condvar_terminate function is a critical-section function that frees a condition variable. Use this function to free a previously allocated condition variable.


Caution – Caution –

Terminating a condition variable that is in use can lead to unpredictable results.


Syntax

void condvar_terminate(CONDVAR cv);

Return Values

void

Parameters

CONDVAR cv is a condition variable.

See Also

condvar_init() Function, condvar_notify() Function, condvar_wait() Function, crit_init() Function, crit_enter() Function, crit_exit() Function, crit_terminate() Function

condvar_wait() Function

The condvar_wait function is a critical-section function that blocks on a given condition variable. Use this function to wait for a critical section, specified by a condition variable argument to become available. The calling thread is blocked until another thread calls condvar_notify with the same condition variable argument. The caller must have entered the critical section associated with this condition variable before calling condvar_wait.

Syntax

void condvar_wait(CONDVAR cv);

Return Values

void

Parameters

CONDVAR cv is a condition variable.

See Also

condvar_init() Function, condvar_terminate() Function, condvar_notify() Function, crit_init() Function, crit_enter() Function, crit_exit() Function, crit_terminate() Function

crit_enter() Function

The crit_enter function is a critical-section function that attempts to enter a critical section. Use this function to gain ownership of a critical section. If another thread already owns the section, the calling thread is blocked until the first thread surrenders ownership by calling crit_exit.

Syntax

void crit_enter(CRITICAL crvar);

Return Values

void

Parameters

CRITICAL crvar is a critical-section variable.

See Also

crit_init() Function, crit_exit() Function, crit_terminate() Function

crit_exit() Function

The crit_exit function is a critical-section function that surrenders ownership of a critical section. Use this function to surrender ownership of a critical section. If another thread is blocked waiting for the section, the block is removed and the waiting thread is given ownership of the section.

Syntax

void crit_exit(CRITICAL crvar);

Return Values

void

Parameters

CRITICAL crvar is a critical-section variable.

See Also

crit_init() Function, crit_enter() Function, crit_terminate() Function

crit_init() Function

The crit_init function is a critical-section function that creates and returns a new critical-section variable, a variable of type CRITICAL. Use this function to obtain a new instance of a variable of type CRITICAL, a critical-section variable. Use this variable to prevent interference between two threads of execution. At the time this variable is created, no thread owns the critical section.


Caution – Caution –

Threads must not own or be waiting for the critical section when crit_terminate is called.


Syntax

CRITICAL crit_init(void);

Return Values

A newly allocated critical-section variable (CRITICAL).

Parameters

none

See Also

crit_enter() Function, crit_exit() Function, crit_terminate() Function

crit_terminate() Function

The crit_terminate function is a critical-section function that removes a previously allocated critical-section variable, a variable of type CRITICAL. Use this function to release a critical-section variable previously obtained by a call to crit_init.

Syntax

void crit_terminate(CRITICAL crvar);

Return Values

void

Parameters

CRITICAL crvar is a critical-section variable.

See Also

crit_init() Function, crit_enter() Function, crit_exit() Function