list_p.h File Reference

Private definitions for the linked list routines. More...

#include <list.h>

Classes
struct	LL_node_
	Definition of a list node structure. More...
Functions
LL_node *	LL_newNode (LL_node *next, unsigned int id, void *pay)
	Create a new linked-list node.
void	LL_deleteNode (LL_node *node)
	Delete a node.
void	LL_deleteNextNode (LL_node *node)
	Delete the next node.
int	LL_newNextNode (LL_node *node, unsigned int id, void *pay)
	Create a new node.
LL_node *	LL_findPrevNode (LL_node *head, unsigned int id)
	Find the previous node.

---

Detailed Description

Private definitions for the linked list routines.

Author:

James Swain & Owen Saxton

Id

list_p.h,v 1.4 2011/03/28 19:01:32 saxton Exp

---

Function Documentation

void LL_deleteNextNode

(

LL_node *

handler

)

Delete the next node.

This routine deletes from the linked list the node after the one pointed to.

Parameters:

handler

Pointer to the node on the linked list preceding the one to be deleted

References LL_deleteNode(), and LL_node_::next.

Referenced by LL_unregisterNode().

void LL_deleteNode

(

LL_node *

handler

)

Delete a node.

This routine frees the memory allocated to t node

Parameters:

handler

Pointer to linked-list node to free

Referenced by LL_deleteNextNode().

LL_node* LL_findPrevNode	(	LL_node *	head,
		unsigned int	uid
	)

Find the previous node.

This routine scans the linked list until either the last node is reached, or the one immediately preceding the specified node.

Parameters:

	head	Pointer to the start of the list of LL handlers
	uid	Unique id of the node being sought

Returns:

Pointer to the node immediately before the one being sought or the last node of the list

References LL_node_::next, and LL_node_::uid.

Referenced by LL_getPayload(), LL_isPresent(), LL_registerNode(), and LL_unregisterNode().

int LL_newNextNode	(	LL_node *	handler,
		unsigned int	uid,
		void *	pay
	)

Create a new node.

This routine creates a new node on the linked list immediately following the one indicated

Parameters:

	handler	Pointer to the node after which the new node is to be added
	uid	Unique ID
	pay	Pointer to the payload

Return values:

	0	The insertion of a new node was successful
	-1	The insertion of a new node failed because of a memory allocation error

References LL_newNode(), and LL_node_::next.

Referenced by LL_registerNode().

LL_node* LL_newNode	(	LL_node *	next,
		unsigned int	uid,
		void *	pay
	)

Create a new linked-list node.

Parameters:

	next	Pointer to use as the next node for the new node
	uid	Unique id for this node
	pay	Pointer to the payload structure associated with this node

Returns:

Pointer to the new linked-list node, or NULL if there is memory allocation failure

References LL_node_::next, LL_node_::pay, and LL_node_::uid.

Referenced by LL_newNextNode().