1NODEUPDOWN_GET_UP_NODES_LIST(3) LIBNODEUPDOWN NODEUPDOWN_GET_UP_NODES_LIST(3)
2
3
4
6 nodeupdown_get_up_nodes_list, nodeupdown_get_down_nodes_list, - get up
7 or down nodes
8
10 #include <nodeupdown.h>
11
12 int nodeupdown_get_up_nodes_list(nodeupdown_t handle, char **list, int
13 len);
14
15 int nodeupdown_get_down_nodes_list(nodeupdown_t handle, char **list,
16 int len);
17
19 nodeupdown_get_up_nodes_list() retrieves a list of noddes that are up
20 and places each node name into the list pointed to by list. len should
21 indicate the number of nodes that can be stored in list. nodeup‐
22 down_get_down_nodes_list() is identical to nodeup‐
23 down_get_up_nodes_list(), except that it retrieves a list of down
24 nodes.
25
26 To avoid passing in a list that is not large enough to store all of the
27 up or down nodes, nodeupdown_nodelist_create(3) should be used to cre‐
28 ate a list that is guaranteed to be large enough to store all of the
29 nodes.
30
32 On success, the number of nodes copied into list is returned. On
33 error, -1 is returned, and an error code is returned in handle. The
34 error code can be retrieved via nodeupdown_errnum(3) , and a descrip‐
35 tion of the error code can be retrieved via nodeupdown_strerror(3).
36 Error codes are defined in nodeupdown.h.
37
39 NODEUPDOWN_ERR_NULLHANDLE
40 The handle parameter is NULL. The nodeupdown handle must be
41 created with nodeupdown_handle_create(3).
42
43 NODEUPDOWN_ERR_NOTLOADED
44 nodeupdown_load_data(3) has not been called and no data has been
45 retrieved.
46
47 NODEUPDOWN_ERR_PARAMETERS
48 An incorrect parameter has been passed in.
49
50 NODEUPDOWN_ERR_NULLPTR
51 A null pointer has been found in the list passed in.
52
53 NODEUPDOWN_ERR_OVERFLOW
54 The list pointed to by list is not large enough to store all the
55 nodes.
56
57 NODEUPDOWN_ERR_OUTMEM
58 malloc(3) has failed internally.
59
60 NODEUPDOWN_ERR_CLUSTERLIST_MODULE
61 Internal error with the clusterlist module
62
63 NODEUPDOWN_ERR_HOSTLIST
64 Hostlist API has failed internally.
65
66 NODEUPDOWN_ERR_MAGIC
67 handle has an incorrect magic number. handle does not point to
68 a nodeupdown handle or handle has been destroyed by nodeup‐
69 down_handle_destroy(3).
70
72 /usr/include/nodeupdown.h
73
75 libnodeupdown(3), nodeupdown_handle_create(3), nodeupdown_load_data(3),
76 nodeupdown_get_up_nodes_string (3), nodeupdown_get_down_nodes_string
77 (3), nodeupdown_errnum(3), nodeupdown_strerror(3)
78
79
80
81LLNL August 2003 NODEUPDOWN_GET_UP_NODES_LIST(3)