Buffer methods

Typedefs
typedef void(*	shim_buffer_free )(char *, void *)

Functions
shim_val_t *	shim_buffer_new (shim_ctx_t *, size_t)
shim_val_t *	shim_buffer_new_copy (shim_ctx_t *, const char *, size_t)
shim_val_t *	shim_buffer_new_external (shim_ctx_t *, char *, size_t, shim_buffer_free, void *)
char *	shim_buffer_value (shim_val_t *)
size_t	shim_buffer_length (shim_val_t *)

Detailed Description

Methods for Buffers

Typedef Documentation

typedef void(* shim_buffer_free)(char *, void *)

The callback that will be called when the Buffer is to be freed

Function Documentation

size_t shim_buffer_length

(

shim_val_t *

val)

Get the size of the buffer

Parameters

val	The given buffer

Returns

THe size of the buffer

shim_val_t* shim_buffer_new	(	shim_ctx_t *	ctx,
		size_t	len
	)

Create a new buffer of length

Parameters

ctx	Current executing context
len	Size of buffer to create

Returns

Wrapped buffer

shim_val_t* shim_buffer_new_copy	(	shim_ctx_t *	ctx,
		const char *	data,
		size_t	len
	)

Copy into a new buffer

Parameters

ctx	Current executing context
data	Data to be copied
len	Length of data to be copied

Returns

Wrapped buffer

shim_val_t* shim_buffer_new_external	(	shim_ctx_t *	ctx,
		char *	data,
		size_t	len,
		shim_buffer_free	cb,
		void *	hint
	)

Create a new buffer and be notified when the buffer is to be freed

Parameters

ctx	Current executing context
data	Data to be used for underlying memory
len	Size of memory being used
cb	Callback that is called when buffer is to be freed
hint	Arbitrary data passed to the callback

Returns

Wrapped buffer

The underlying memory is not copied, but used in place

char* shim_buffer_value

(

shim_val_t *

val)

Get the underlying memory for the Buffer

Parameters

val	THe given buffer

Returns

Pointer to the underlying memory