NCX Back Pointers

General Utility to store a back pointer to another pointer. More...

Collaboration diagram for NCX Back Pointers:

Functions
ncx_backptr_t *	ncx_new_backptr (void *node)
	Malloc and initialize a new ncx_backptr_t struct. More...
void	ncx_free_backptr (ncx_backptr_t *ptr)
	Free an ncx_backptr_t struct. More...
void	ncx_free_mbackptr (ncx_backptr_t *ptr)
	Free an ncx_backptr_t struct; Free the 'node' pointer first. More...
void	ncx_clean_backptrQ (dlq_hdr_t *backptrQ)
	Clean an entire Q of ncx_backptr_t structs. More...
void	ncx_clean_mbackptrQ (dlq_hdr_t *backptrQ)
	Clean an entire Q of ncx_backptr_t structs Use ncx_free_mbackptr to free node pointers. More...
ncx_backptr_t *	ncx_first_backptr (dlq_hdr_t *que)
	Get first back pointer struct. More...
const ncx_backptr_t *	ncx_first_const_backptr (const dlq_hdr_t *que)
	Get first back pointer struct CONST. More...
ncx_backptr_t *	ncx_last_backptr (dlq_hdr_t *que)
	Get last back pointer struct. More...
ncx_backptr_t *	ncx_next_backptr (ncx_backptr_t *curptr)
	Get next back pointer struct. More...
const ncx_backptr_t *	ncx_next_const_backptr (const ncx_backptr_t *curptr)
	Get next back pointer struct CONST. More...
ncx_backptr_t *	ncx_prev_backptr (ncx_backptr_t *curptr)
	Get previous back pointer struct. More...
void *	ncx_get_backptr_node (ncx_backptr_t *backptr)
	Get the back pointer node pointer. More...
const void *	ncx_get_const_backptr_node (const ncx_backptr_t *backptr)
	Get the back pointer node pointer CONST. More...
void	ncx_remove_backptr (ncx_backptr_t *ptr)
	Remove the specified backptr for deletion. More...
ncx_backptr_t *	ncx_find_backptr (const dlq_hdr_t *que, void *node)
	Find the specified back pointer struct. More...

Detailed Description

General Utility to store a back pointer to another pointer.

Maintained in a dlq_hdr_t queue

Const Back Pointers

The ncx_backptr_t is used for both constant and malloced back-pointers. The caller needs to know which free function to use.

Function Documentation

ncx_clean_backptrQ()

void ncx_clean_backptrQ

(

dlq_hdr_t *

backptrQ

)

Clean an entire Q of ncx_backptr_t structs.

Parameters

backptrQ

Q of ncx_backptr_t to use

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_clean_mbackptrQ()

void ncx_clean_mbackptrQ

(

dlq_hdr_t *

backptrQ

)

Clean an entire Q of ncx_backptr_t structs Use ncx_free_mbackptr to free node pointers.

Parameters

backptrQ

Q of ncx_backptr_t to use

Here is the call graph for this function:

Here is the caller graph for this function:

ncx_find_backptr()

ncx_backptr_t * ncx_find_backptr	(	const dlq_hdr_t *	que,
		void *	node
	)

Find the specified back pointer struct.

Parameters

que	the queue of ncx_backptr_t to check
node	the node to find

Returns

pointer to the found backptr entry or NULL if not found

Here is the caller graph for this function:

ncx_first_backptr()

ncx_backptr_t * ncx_first_backptr

(

dlq_hdr_t *

que

)

Get first back pointer struct.

Parameters

que	the queue of ncx_backptr_t to check

Returns

pointer to first entry or NULL if none

Here is the caller graph for this function:

ncx_first_const_backptr()

const ncx_backptr_t * ncx_first_const_backptr

(

const dlq_hdr_t *

que

)

Get first back pointer struct CONST.

Parameters

que	the queue of ncx_backptr_t to check

Returns

pointer to first entry or NULL if none

ncx_free_backptr()

void ncx_free_backptr

(

ncx_backptr_t *

ptr

)

Free an ncx_backptr_t struct.

Parameters

ptr	struct to free

See also

ncx_new_backptr

Here is the caller graph for this function:

ncx_free_mbackptr()

void ncx_free_mbackptr

(

ncx_backptr_t *

ptr

)

Free an ncx_backptr_t struct; Free the 'node' pointer first.

Only use this function if the back pointer node can be released by calling the __free macro. Do not use if a special free function is needed

Parameters

ptr	struct to free

See also

ncx_new_backptr

Here is the caller graph for this function:

ncx_get_backptr_node()

void * ncx_get_backptr_node

(

ncx_backptr_t *

backptr

)

Get the back pointer node pointer.

Parameters

backptr

the ncx_backptr_t to check

Returns

pointer to node within backptr

Here is the caller graph for this function:

ncx_get_const_backptr_node()

const void * ncx_get_const_backptr_node

(

const ncx_backptr_t *

backptr

)

Get the back pointer node pointer CONST.

Parameters

backptr

the ncx_backptr_t to check

Returns

pointer to node within backptr

ncx_last_backptr()

ncx_backptr_t * ncx_last_backptr

(

dlq_hdr_t *

que

)

Get last back pointer struct.

Parameters

que	the queue of ncx_backptr_t to check

Returns

pointer to last entry or NULL if none

Here is the caller graph for this function:

ncx_new_backptr()

ncx_backptr_t * ncx_new_backptr

(

void *

node

)

Malloc and initialize a new ncx_backptr_t struct.

Parameters

node	pointer to cache in the back-ptr struct

Returns

malloced struct or NULL if memory error

Here is the caller graph for this function:

ncx_next_backptr()

ncx_backptr_t * ncx_next_backptr

(

ncx_backptr_t *

curptr

)

Get next back pointer struct.

Parameters

curptr

the current ncx_backptr_t to check

Returns

pointer to next entry or NULL if none

Here is the caller graph for this function:

ncx_next_const_backptr()

const ncx_backptr_t * ncx_next_const_backptr

(

const ncx_backptr_t *

curptr

)

Get next back pointer struct CONST.

Parameters

curptr

the current ncx_backptr_t to check

Returns

pointer to next entry or NULL if none

ncx_prev_backptr()

ncx_backptr_t * ncx_prev_backptr

(

ncx_backptr_t *

curptr

)

Get previous back pointer struct.

Parameters

curptr

the current ncx_backptr_t to check

Returns

pointer to previous entry or NULL if none

Here is the caller graph for this function:

ncx_remove_backptr()

void ncx_remove_backptr

(

ncx_backptr_t *

ptr

)

Remove the specified backptr for deletion.

Parameters

ptr	the current ncx_backptr_t to check

Here is the call graph for this function:

Here is the caller graph for this function: