All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Macros | Enumerations | Functions
as_stream.h File Reference
#include <stdlib.h>
#include <aerospike/as_val.h>
#include <aerospike/as_util.h>
#include <citrusleaf/alloc.h>
+ Include dependency graph for as_stream.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  as_stream
 
struct  as_stream_hooks
 

Macros

#define AS_STREAM_END   ((void *) 0)
 

Enumerations

enum  as_stream_status { AS_STREAM_OK = 0, AS_STREAM_ERR = 1 }
 

Functions

void as_stream_destroy (as_stream *stream)
 
void as_stream_free (void *ptr)
 
as_streamas_stream_init (as_stream *stream, void *data, const as_stream_hooks *hooks)
 
void * as_stream_malloc (size_t size)
 
as_streamas_stream_new (void *data, const as_stream_hooks *hooks)
 
as_valas_stream_read (const as_stream *stream)
 
bool as_stream_readable (const as_stream *stream)
 
void * as_stream_source (const as_stream *stream)
 
bool as_stream_writable (const as_stream *stream)
 
as_stream_status as_stream_write (const as_stream *stream, as_val *value)
 

Macro Definition Documentation

#define AS_STREAM_END   ((void *) 0)

Definition at line 36 of file as_stream.h.

Enumeration Type Documentation

Stream Status Codes

Enumerator
AS_STREAM_OK 
AS_STREAM_ERR 

Definition at line 47 of file as_stream.h.

Function Documentation

void as_stream_destroy ( as_stream stream)
inline

Destroy the as_stream and associated resources.

Parameters
streamThe stream to destroy.
Returns
0 on success, otherwise 1.

Definition at line 166 of file as_stream.h.

References as_stream_free(), as_util_hook, and as_stream::free.

void as_stream_free ( void *  ptr)
as_stream * as_stream_init ( as_stream stream,
void *  data,
const as_stream_hooks hooks 
)
inline

Initializes a stack allocated as_stream for a given source and hooks.

Parameters
streamThe stream to initialize.
dataThe source feeding the stream
hooksThe hooks that interface with the source
Returns
On success, the initialized stream. Otherwise NULL.

Definition at line 126 of file as_stream.h.

References as_stream::data, as_stream::free, and as_stream::hooks.

void* as_stream_malloc ( size_t  size)

Wrapper functions to ensure each CF allocation-related function call has a unique line.

as_stream * as_stream_new ( void *  data,
const as_stream_hooks hooks 
)
inline

Creates a new heap allocated as_stream for a given source and hooks.

Parameters
dataThe source feeding the stream
hooksThe hooks that interface with the source
Returns
On success, a new stream. Otherwise NULL.

Definition at line 146 of file as_stream.h.

References as_stream_malloc(), as_stream::data, as_stream::free, and as_stream::hooks.

as_val * as_stream_read ( const as_stream stream)
inline

Reads a value from the stream

Parameters
streamThe stream to be read.
Returns
the element read from the stream or STREAM_END

Definition at line 201 of file as_stream.h.

References as_util_hook.

bool as_stream_readable ( const as_stream stream)
inline

Is the stream readable? Tests whether the stream has a read function.

Parameters
streamThe stream to test.
Returns
true if the stream can be read from

Definition at line 215 of file as_stream.h.

References as_stream::hooks.

void * as_stream_source ( const as_stream stream)
inline

Get the source for the stream

Parameters
streamThe stream to get the source from
Returns
pointer to the source of the stream

Definition at line 187 of file as_stream.h.

References as_stream::data.

bool as_stream_writable ( const as_stream stream)
inline

Is the stream writable? Tests whether the stream has a write function.

Parameters
streamThe stream to test.
Returns
true if the stream can be written to.

Definition at line 245 of file as_stream.h.

References as_stream::hooks.

as_stream_status as_stream_write ( const as_stream stream,
as_val value 
)
inline

Write a value to the stream

Parameters
streamThe stream to write to.
valueThe element to write to the stream.
Returns
AS_STREAM_OK on success, otherwise is failure.

Definition at line 230 of file as_stream.h.

References AS_STREAM_ERR, and as_util_hook.