Loading...
Searching...
No Matches
Typedefs | Functions
Info Operations

Description

The Info API provides the ability to query server node(s) for statistics and set dynamically configurable variables.

+ Collaboration diagram for Info Operations:

Typedefs

typedef bool(* aerospike_info_foreach_callback) (const as_error *err, const as_node *node, const char *req, char *res, void *udata)
 

Functions

AS_EXTERN as_status aerospike_info_any (aerospike *as, as_error *err, const as_policy_info *policy, const char *req, char **res)
 
AS_EXTERN 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_EXTERN as_status aerospike_info_host (aerospike *as, as_error *err, const as_policy_info *policy, const char *hostname, uint16_t port, const char *req, char **res)
 
AS_EXTERN as_status aerospike_info_node (aerospike *as, as_error *err, const as_policy_info *policy, as_node *node, const char *req, char **res)
 
static as_status aerospike_info_node_async (aerospike *as, as_error *err, as_policy_info *policy, as_node *node, const char *req, as_async_info_listener listener, void *udata, as_event_loop *event_loop)
 
AS_EXTERN 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 Documentation

◆ aerospike_info_foreach_callback

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
errThe status and possible error information for the info request.
nodeThe node which provided the response.
reqThe initial request.
resThe response to the info request.
udataThe udata provided to the aerospike_info_foreach()
Returns
TRUE to continue to the next info response. FALSE to stop processing.

Definition at line 56 of file aerospike_info.h.

Function Documentation

◆ aerospike_info_any()

AS_EXTERN as_status aerospike_info_any ( aerospike * as,
as_error * err,
const as_policy_info * policy,
const char * req,
char ** res )

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;
if (aerospike_info_any(&as, &err, NULL, "info", &res) != AEROSPIKE_OK) {
// handle error
}
else {
// handle response
free(res);
res = NULL;
}
@ AEROSPIKE_OK
Definition as_status.h:128
AS_EXTERN as_status aerospike_info_any(aerospike *as, as_error *err, const as_policy_info *policy, const char *req, char **res)
Parameters
asThe aerospike instance to use for this operation.
errThe as_error to be populated if an error occurs.
policyThe policy to use for this operation. If NULL, then the default policy will be used.
reqThe info request to send.
resThe 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.

◆ aerospike_info_foreach()

AS_EXTERN 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 )

Send an info request to the entire cluster.

if (aerospike_info_foreach(&as, &err, NULL, "info", callback, NULL) != AEROSPIKE_OK) {
// handle error
}
AS_EXTERN 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)

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) {
// handle response
}
Parameters
asThe aerospike instance to use for this operation.
errThe as_error to be populated if an error occurs.
policyThe policy to use for this operation. If NULL, then the default policy will be used.
reqThe info request to send.
callbackThe function to call when a response is received.
udataUser-data to send to the callback.
Returns
AEROSPIKE_OK on success. Otherwise an error.

◆ aerospike_info_host()

AS_EXTERN as_status aerospike_info_host ( aerospike * as,
as_error * err,
const as_policy_info * policy,
const char * hostname,
uint16_t port,
const char * req,
char ** res )

Send an info request to a specific host. The response must be freed by the caller on success.

char* res = NULL;
if (aerospike_info_host(&as, &err, NULL, "127.0.0.1", 3000, "info", &res) != AEROSPIKE_OK) {
// handle error
}
else {
// handle response
free(res);
res = NULL;
}
AS_EXTERN as_status aerospike_info_host(aerospike *as, as_error *err, const as_policy_info *policy, const char *hostname, uint16_t port, const char *req, char **res)

This function does not support TLS nor the new user authentication protocol.

Deprecated
Use aerospike_info_node() or aerospike_info_any() instead.
Parameters
asThe aerospike instance to use for this operation.
errThe as_error to be populated if an error occurs.
policyThe policy to use for this operation. If NULL, then the default policy will be used.
hostnameThe IP address or hostname to send the request to.
portThe port to send the request to.
reqThe info request to send.
resThe 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.

◆ aerospike_info_node()

AS_EXTERN as_status aerospike_info_node ( aerospike * as,
as_error * err,
const as_policy_info * policy,
as_node * node,
const char * req,
char ** res )

Send an info request to a specific server node. The response must be freed by the caller on success.

char* res = NULL;
if (aerospike_info_node(&as, &err, NULL, node, "info", &res) != AEROSPIKE_OK) {
// handle error
}
else {
// handle response
free(res);
}
AS_EXTERN as_status aerospike_info_node(aerospike *as, as_error *err, const as_policy_info *policy, as_node *node, const char *req, char **res)
Parameters
asThe aerospike instance to use for this operation.
errThe as_error to be populated if an error occurs.
policyThe policy to use for this operation. If NULL, then the default policy will be used.
nodeThe server node to send the request to.
reqThe info request to send.
resThe 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.

◆ aerospike_info_node_async()

static as_status aerospike_info_node_async ( aerospike * as,
as_error * err,
as_policy_info * policy,
as_node * node,
const char * req,
as_async_info_listener listener,
void * udata,
as_event_loop * event_loop )
inlinestatic

Asynchronously send an info request to a specific server node.

void my_listener(as_error* err, char* response, void* udata, as_event_loop* event_loop)
{
if (err) {
printf("Command failed: %d %s\n", err->code, err->message);
return;
}
// Process response
// Do not free response because the calling function will do that for you.
}
aerospike_info_node_async(&as, &err, NULL, node, "info", my_listener, NULL, NULL);
static as_status aerospike_info_node_async(aerospike *as, as_error *err, as_policy_info *policy, as_node *node, const char *req, as_async_info_listener listener, void *udata, as_event_loop *event_loop)
char message[AS_ERROR_MESSAGE_MAX_SIZE]
Definition as_error.h:103
as_status code
Definition as_error.h:98
Parameters
asThe aerospike instance to use for this operation.
errThe as_error to be populated if an error occurs.
policyThe info policy. If NULL, the default info policy will be used.
nodeThe server node to send the request to.
reqThe info request to send.
listenerUser function to be called with command results.
udataUser data to be forwarded to user callback.
event_loopEvent loop assigned to run this command. If NULL, an event loop will be chosen by round-robin.
Returns
AEROSPIKE_OK on success. Otherwise an error.

Definition at line 126 of file aerospike_info.h.

References as_info_command_node_async().

◆ aerospike_info_socket_address()

AS_EXTERN 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 )

Send an info request to a specific socket address. The response must be freed by the caller on success.

char* res = NULL;
if (aerospike_info_socket_address(&as, &err, NULL, &sa_in, "info", &res) != AEROSPIKE_OK) {
// handle error
}
else {
// handle response
free(res);
res = NULL;
}
AS_EXTERN 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)

This function does not support TLS, IPv6 nor the new user authentication protocol.

Deprecated
Use aerospike_info_node() or aerospike_info_any() instead.
Parameters
asThe aerospike instance to use for this operation.
errThe as_error to be populated if an error occurs.
policyThe policy to use for this operation. If NULL, then the default policy will be used.
sa_inThe IP address and port to send the request to.
reqThe info request to send.
resThe 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.