OpenIO SDS C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Data Fields
oio_sds_list_listener_s Struct Reference

#include <oio_sds.h>

Data Fields

void * ctx
 
int(* on_item )(void *ctx, const struct oio_sds_list_item_s *item)
 
int(* on_prefix )(void *ctx, const char *prefix)
 
int(* on_bound )(void *ctx, const char *next_marker)
 
size_t out_count
 
int out_truncated
 

Field Documentation

void* oio_sds_list_listener_s::ctx

An arbitraty pointer that will be passed as-is to all the hooks producing an output for this listing.

int(* oio_sds_list_listener_s::on_bound)(void *ctx, const char *next_marker)

called once, with no warranty to be called before 'on_item' nor 'on_bound'

int(* oio_sds_list_listener_s::on_item)(void *ctx, const struct oio_sds_list_item_s *item)

called for each item listed

int(* oio_sds_list_listener_s::on_prefix)(void *ctx, const char *prefix)

called for each sub-prefix detected (depends on the delimiter)

size_t oio_sds_list_listener_s::out_count

How many items have been returned, eventually

int oio_sds_list_listener_s::out_truncated

Has the list been truncated. If so, a subsequent call to list with the appropriate marker shoudl be issued for a full list.


The documentation for this struct was generated from the following file: