PluginAPI_types.h File Reference

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Classes
struct	llcas_digest_t
	Digest hash bytes. More...
struct	llcas_data_t
	Data buffer for stored CAS objects. More...
struct	llcas_objectid_t
	Identifier for a CAS object. More...
struct	llcas_loaded_object_t
	A loaded CAS object. More...
struct	llcas_object_refs_t
	Object references for a CAS object. More...

Macros
#define	LLCAS_VERSION_MAJOR   0
#define	LLCAS_VERSION_MINOR   1

Typedefs
typedef struct llcas_cas_options_s *	llcas_cas_options_t
typedef struct llcas_cas_s *	llcas_cas_t
typedef struct llcas_cancellable_s *	llcas_cancellable_t
typedef void(*	llcas_cas_load_object_cb) (void *ctx, llcas_lookup_result_t, llcas_loaded_object_t, char *error)
	Callback for llcas_cas_load_object_async.
typedef void(*	llcas_actioncache_get_cb) (void *ctx, llcas_lookup_result_t, llcas_objectid_t, char *error)
	Callback for llcas_actioncache_get_for_digest_async.
typedef void(*	llcas_actioncache_put_cb) (void *ctx, bool failed, char *error)
	Callback for llcas_actioncache_put_for_digest_async.

Enumerations
enum	llcas_lookup_result_t { LLCAS_LOOKUP_RESULT_SUCCESS = 0 , LLCAS_LOOKUP_RESULT_NOTFOUND = 1 , LLCAS_LOOKUP_RESULT_ERROR = 2 }
	Return values for a load operation. More...

Macro Definition Documentation

LLCAS_VERSION_MAJOR

#define LLCAS_VERSION_MAJOR   0

Definition at line 22 of file PluginAPI_types.h.

LLCAS_VERSION_MINOR

#define LLCAS_VERSION_MINOR   1

Definition at line 23 of file PluginAPI_types.h.

Typedef Documentation

llcas_actioncache_get_cb

typedef void(* llcas_actioncache_get_cb) (void *ctx, llcas_lookup_result_t, llcas_objectid_t, char *error)

Callback for llcas_actioncache_get_for_digest_async.

Parameters

ctx	pointer passed through from the llcas_actioncache_get_for_digest_async call.
error	message if an error occurred. If set, the memory it points to needs to be released via llcas_string_dispose.

Definition at line 106 of file PluginAPI_types.h.

llcas_actioncache_put_cb

typedef void(* llcas_actioncache_put_cb) (void *ctx, bool failed, char *error)

Callback for llcas_actioncache_put_for_digest_async.

Parameters

ctx	pointer passed through from the llcas_actioncache_put_for_digest_async call.
error	message if an error occurred. If set, the memory it points to needs to be released via llcas_string_dispose.

Definition at line 117 of file PluginAPI_types.h.

llcas_cancellable_t

typedef struct llcas_cancellable_s* llcas_cancellable_t

Definition at line 27 of file PluginAPI_types.h.

llcas_cas_load_object_cb

typedef void(* llcas_cas_load_object_cb) (void *ctx, llcas_lookup_result_t, llcas_loaded_object_t, char *error)

Callback for llcas_cas_load_object_async.

Parameters

ctx	pointer passed through from the llcas_cas_load_object_async call.
error	message if an error occurred. If set, the memory it points to needs to be released via llcas_string_dispose.

Definition at line 95 of file PluginAPI_types.h.

llcas_cas_options_t

typedef struct llcas_cas_options_s* llcas_cas_options_t

Definition at line 25 of file PluginAPI_types.h.

llcas_cas_t

typedef struct llcas_cas_s* llcas_cas_t

Definition at line 26 of file PluginAPI_types.h.

Enumeration Type Documentation

llcas_lookup_result_t

enum llcas_lookup_result_t

Return values for a load operation.

Enumerator
LLCAS_LOOKUP_RESULT_SUCCESS	The object was found.
LLCAS_LOOKUP_RESULT_NOTFOUND	The object was not found.
LLCAS_LOOKUP_RESULT_ERROR	An error occurred.

Definition at line 70 of file PluginAPI_types.h.