The Info API provides the ability to query an Aerospike cluster for information.
The following API are provided:
|
as_status | aerospike_info_any (aerospike *as, as_error *err, const as_policy_info *policy, const char *req, char **res) |
|
as_status | aerospike_info_foreach (aerospike *as, as_error *err, const as_policy_info *policy, const char *req, aerospike_info_foreach_callback callback, void *udata) |
|
as_status | aerospike_info_host (aerospike *as, as_error *err, const as_policy_info *policy, const char *addr, uint16_t port, const char *req, char **res) |
|
as_status | aerospike_info_socket_address (aerospike *as, as_error *err, const as_policy_info *policy, struct sockaddr_in *sa_in, const char *req, char **res) |
|
typedef bool(* aerospike_info_foreach_callback)(const as_error *err, const as_node *node, const char *req, char *res, void *udata) |
Callback for aerospike_info_foreach()
- Parameters
-
err | The status and possible error information for the info request. |
node | The node which provided the response. |
res | The response to the info request. |
udata | The udata provided to the aerospike_info_foreach() |
- Returns
- TRUE to continue to the next info response. FALSE to stop processing.
Definition at line 59 of file aerospike_info.h.
Send an info request to a node in the cluster. If node request fails, send request to the next node in the cluster. Repeat until the node request succeeds. The response must be freed by the caller on success.
char * res = NULL;
}
else {
free(res);
res = NULL;
}
- Parameters
-
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
req | The info request to send. |
res | The response from the node. The response will be a NULL terminated string, allocated by the function, and must be freed by the caller. |
- Returns
- AEROSPIKE_OK on success. Otherwise an error.
Send an info request to the entire cluster.
The callback takes a response string. The caller should not free this string.
bool callback(
const as_error * err,
const as_node * node,
const char * req,
char * res,
void * udata) {
}
- Parameters
-
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
req | The info request to send. |
callback | The function to call when a response is received. |
udata | User-data to send to the callback. |
- Returns
- AEROSPIKE_OK on success. Otherwise an error.
Send an info request to a specific host. The response must be freed by the caller on success.
char * res = NULL;
}
else {
free(res);
res = NULL;
}
- Parameters
-
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
addr | The IP address or hostname to send the request to. |
port | The port to send the request to. |
req | The info request to send. |
res | The response from the node. The response will be a NULL terminated string, allocated by the function, and must be freed by the caller. |
- Returns
- AEROSPIKE_OK on success. Otherwise an error.
Send an info request to a specific socket address. The response must be freed by the caller on success.
char * res = NULL;
}
else {
free(res);
res = NULL;
}
- Parameters
-
as | The aerospike instance to use for this operation. |
err | The as_error to be populated if an error occurs. |
policy | The policy to use for this operation. If NULL, then the default policy will be used. |
sa_in | The IP address and port to send the request to. |
req | The info request to send. |
res | The response from the node. The response will be a NULL terminated string, allocated by the function, and must be freed by the caller. |
- Returns
- AEROSPIKE_OK on success. Otherwise an error.