20.1 Functions provided by the C client library

The C client library provides an EADS API that consists of the functions shown in the table below. Source programs written in the C can use these functions by including the header file provided by EADS.

Note that the functions available in the C client library (except ead_terminate_client()) are thread-safe.

Table 20‒1: Functions available in the C client library and their header file
No.	Function name	Description	Header file
1	`ead_init_client()`	Performs initial setup of the EADS client according to the client properties.	`eads.h`
2	`ead_init_client_n()`	Initializes the EADS client according to the EADS client name and client properties.
3	`ead_start_cache()`	Starts access to the cache and obtains a handle (pointer) for accessing the specified cache.
4	`ead_stop_cache()`	Stops access to a specified cache.
5	`ead_get_cache_name()`	Acquires the cache name associated with the handle to a specified cache.
6	`ead_terminate_client()`	Terminates the EADS client.
7	`ead_put()`	Stores a value by associating it with a key.
8	`ead_put_array_value()`	Concatenates multiple values and then stores the values by associating them with keys.
9	`ead_put_all()`	Using a batch operation, this function stores multiple keys and values in cache.
10	`ead_create()`	Stores a value with a key only when a new key is stored.
11	`ead_update()`	Stores a value with the specified key only if the key is already stored (updates the value).
12	`ead_replace()`	Compares the value associated with a specified key to the value information specified in a comparison condition, and stores the value with the key only if the values match (replaces the value).
13	`ead_get()`	Retrieves the value associated with a specified key.
14	`ead_get_all()`	Using a batch operation, this function acquires the values associated with a specified list of keys.
15	`ead_get_group()`	Using a batch operation, this function acquires the values associated with keys that belong to a specified group and its lower hierarchy groups.
16	`ead_remove()`	Deletes a specified key and the value associated with that key.
17	`ead_remove_all()`	Using a batch operation, this function deletes the values associated with a specified list of keys.
18	`ead_remove_group()`	Using a batch operation, this function deletes the keys and values that belong to a specified group, including the keys and values that belong to lower hierarchy groups.
19	`ead_remove_node()`	Using a batch operation, this function deletes keys and values that were copied from a specified EADS server.
20	`ead_get_group_names()`	Acquires a list of the group names of the groups in the highest hierarchy that are stored on a specified EADS server. The group names are listed in ascending order based on their ASCII code values.
21	`ead_get_group_keys()`	Acquires a list of keys that belong to a specified group, including keys that belong to groups under the specified group's hierarchy. The keys are listed in ascending order based on their ASCII code values.
22	`ead_get_node_keys()`	Acquires a list of keys stored on a specified EADS server. The keys are listed in ascending order based on their ASCII code values.
23	`ead_get_group_count()`	Acquires the number of groups in the highest hierarchy that are stored on a specified EADS server.
24	`ead_get_group_key_count()`	Acquires the number of keys that belong to a specified group. The number of keys acquired includes the keys that belong to groups under the specified group's hierarchy.
25	`ead_get_node_key_count()`	Acquires the number of keys that are stored on a specified EADS server.
26	`ead_get_group_first_key()`	Acquires the first key in ascending order based on its ASCII code value from among all the keys that belong to a specified group. The keys that belong to groups under the specified group's hierarchy are also subject to this acquisition processing.
27	`ead_get_node_first_key()`	Acquires the first key in ascending order based on its ASCII code value from among all the keys stored on a specified EADS server.
28	`ead_get_group_next_key()`	Acquires the key that immediately follows a specified key in ascending order based on its ASCII code value from among all the keys that belong to a specified group. The keys that belong to the groups under the specified group's hierarchy are also subject to this acquisition processing.
29	`ead_get_node_next_key()`	Acquires the key that immediately follows a specified key in ascending order based on its ASCII code value from among all the keys that are stored on a specified EADS server.
30	`ead_execute_function()`	Uses a specified key or group to determine the EADS server on which a user function is to be executed and then executes that user function.
31	`ead_execute_function_rt()`	Uses a specified key or group to determine the EADS server on which a user function is to be executed and then executes that user function. This function also sets a reception timeout value.
32	`ead_execute_node_function()`	Executes a user function with an EADS server specified.
33	`ead_execute_node_function_rt()`	Executes a user function with an EADS server specified and sets a reception timeout value.
34	`ead_get_nodelist()`	Acquires information about the connection-target EADS servers maintained by the EADS client.
35	[Deprecated] `ead_get_node()`	[Deprecated] Acquires information about the original source EADS server that stores a specified key or group.
36	`ead_get_slave_nodelist()`	Acquires information about the original target EADS servers to which data stored on a specified EADS server is copied.
37	`ead_get_current_master_node()`	Acquires information about the source EADS server that currently stores a specified key (or group).
38	`ead_get_original_master_node()`	Acquires information about the original source EADS server that stores a specified key (or group).

Organization of this section

To Page Top