Node Objects
[State Object Library]

Data Structures
struct	sos_node_group_t
struct	sos_node_t
Typedefs
typedef sos_node_t	sos_node_t
typedef sos_node_group_t	sos_node_group_t
Functions
	SUL_PEER_DECLARE (node_groups)
	SUL_PEER_DECLARE (nodes)
	sos_node_group_create (const char *name, apr_pool_t *pool)
	sos_node_group_get_all (apr_array_header_t **array, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_get_node (apr_array_header_t **array, sos_node_t *node, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_get_name (sos_node_group_t **group, const char *name, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_get_key (sos_node_group_t **group, sul_key_t identifier, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_save (sos_node_group_t *group, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_find (const char *name, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_get_unique (sos_node_group_t **group, const char *name, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_has_group (sos_node_group_t *group, sos_node_group_t *memb, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_groups_remove (sos_node_group_t *group, sos_node_group_t *memb, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_groups_add (sos_node_group_t *group, sos_node_group_t *memb, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_has_node (sos_node_group_t *group, sos_node_t *memb, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_nodes_remove (sos_node_group_t *group, sos_node_t *memb, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_group_nodes_add (sos_node_group_t *group, sos_node_t *memb, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_create (const char *ip, apr_pool_t *pool)
	sos_node_get_all (apr_array_header_t **array, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_get_local (sos_node_t **node, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_get_key (sos_node_t **node, sul_key_t identifier, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_get_ip (sos_node_t **node, const char *ip, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_get_ip_or_name (sos_node_t **node, const char *identity, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_get_in_group (apr_array_header_t **array, const char *name, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_find (const char *ip, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_set_pinged (sos_node_t *node, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_save (sos_node_t *node, sos_fs_txn_t *txn, apr_pool_t *pool)
	sos_node_get_unique (sos_node_t **node, const char *ip, sos_fs_txn_t *txn, apr_pool_t *pool)

---

Typedef Documentation

typedef struct sos_node_group_t sos_node_group_t

Node groups are just collections of nodes. A node can be to any number of node groups. They simplify task creation and other activities since many times node groups can be operated on, as well as individual nodes.

typedef struct sos_node_t sos_node_t

Nodes are at the very core of the system. Nodes represent machines with IP addresses, put simply. A printer, a router, a server, a disk array, etc... are all examples of Nodes.

---

Function Documentation

sos_node_create (  const char *  ip, apr_pool_t *  pool )

Parameters: ip  pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_find (  const char *  ip, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: ip  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_get_all (  apr_array_header_t **  array, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: array  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_get_in_group (  apr_array_header_t **  array, const char *  name, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: array  name  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_get_ip (  sos_node_t **  node, const char *  ip, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: node  ip  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_get_ip_or_name (  sos_node_t **  node, const char *  identity, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: node  identity  Either the Name or the IP of the Node we'd like to retrieve. txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_get_key (  sos_node_t **  node, sul_key_t  identifier, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: node  identifier  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_get_local (  sos_node_t **  node, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: node  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_get_unique (  sos_node_t **  node, const char *  ip, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: node  ip  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_create (  const char *  name, apr_pool_t *  pool )

Parameters: name  pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_find (  const char *  name, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: name  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_get_all (  apr_array_header_t **  array, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Gets all of the Node Groups in the file system. Parameters: array  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_get_key (  sos_node_group_t **  group, sul_key_t  identifier, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: group  identifier  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_get_name (  sos_node_group_t **  group, const char *  name, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Gets the Node Group with the specified name from the file system. Parameters: group  name  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_get_node (  apr_array_header_t **  array, sos_node_t *  node, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Gets all of the Node Groups in the file system. Parameters: array  node  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_get_unique (  sos_node_group_t **  group, const char *  name, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: group  name  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_nodes_add (  sos_node_group_t *  group, sos_node_t *  node, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: group  node  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_nodes_remove (  sos_node_group_t *  group, sos_node_t *  node, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: group  node  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_group_save (  sos_node_group_t *  group, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Saves any changes made directly to the Node Group object to the file system. Parameters: group  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_save (  sos_node_t *  node, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: node  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

sos_node_set_pinged (  sos_node_t *  node, sos_fs_txn_t *  txn, apr_pool_t *  pool )

Parameters: node  txn  A database transaction. pool  Memory pool to allocate overhead from. Returns: An sul_error_t instance if an error occured and NULL otherwise.

---