flux_kvs_getroot(3)

SYNOPSIS

#include <flux/core.h>

flux_future_t *flux_kvs_getroot (flux_t *h,
                                 const char *ns,
                                 int flags);

int flux_kvs_getroot_get_treeobj (flux_future_t *f,
                                  const char **treeobj);

int flux_kvs_getroot_get_blobref (flux_future_t *f,
                                  const char **blobref);

int flux_kvs_getroot_get_sequence (flux_future_t *f, int *seq);

int flux_kvs_getroot_get_owner (flux_future_t *f, uint32_t *owner);

Link with -lflux-core.

DESCRIPTION

flux_kvs_getroot() sends a request via handle h to the kvs service to look up the current root hash for namespace ns. A flux_future_t object is returned, which acts as handle for synchronization and container for the response. flags is currently unused and should be set to 0.

Upon future fulfillment, these functions can decode the result:

flux_kvs_getroot_get_treeobj() obtains the root hash in the form of an RFC 11 dirref treeobj, suitable to be passed to flux_kvs_lookupat(3).

flux_kvs_getroot_get_blobref() obtains the RFC 10 blobref, suitable to be passed to flux_content_load(7).

flux_kvs_getroot_get_sequence() retrieves the monotonic sequence number for the root.

flux_kvs_getroot_get_owner() retrieves the namespace owner.

FLAGS

The flags mask is currently unused and should be set to 0.

RETURN VALUE

flux_kvs_getroot() returns a flux_future_t on success, or NULL on failure with errno set appropriately.

The other functions return zero on success, or -1 on failure with errno set appropriately.

ERRORS

EINVAL: One of the arguments was invalid.
ENOMEM: Out of memory.
EPROTO: A request was malformed.
ENOSYS: The kvs module is not loaded.
ENOTSUP: An unknown namespace was requested or namespace was deleted.
EPERM: The requesting user is not permitted to access the requested namespace.
ENODATA: A stream of responses has been terminated by a call to flux_kvs_getroot_cancel().