Memory
[High Level API]


Functions

void ops_memory_init (ops_memory_t *mem, size_t initial_size)
 Memory to initialise.
void ops_memory_pad (ops_memory_t *mem, size_t length)
 Pad memory to required length.
void ops_memory_add (ops_memory_t *mem, const unsigned char *src, size_t length)
 Add data to memory.
void ops_memory_clear (ops_memory_t *mem)
 Retains allocated memory and set length of stored data to zero.
void ops_memory_release (ops_memory_t *mem)
 Free memory and associated data.
ops_memory_tops_memory_new ()
 Create a new zeroed ops_memory_t.
void ops_memory_free (ops_memory_t *mem)
 Free memory ptr and associated memory.
size_t ops_memory_get_length (const ops_memory_t *mem)
 Get length of data stored in ops_memory_t struct.
void * ops_memory_get_data (ops_memory_t *mem)
 Get data stored in ops_memory_t struct.

Function Documentation

void ops_memory_add ops_memory_t mem,
const unsigned char *  src,
size_t  length
 

Add data to memory.

Parameters:
mem Memory to which to add
src Data to add
length Length of data to add

void ops_memory_clear ops_memory_t mem  ) 
 

Retains allocated memory and set length of stored data to zero.

Parameters:
mem Memory to clear
See also:
ops_memory_release()

ops_memory_free()

void ops_memory_free ops_memory_t mem  ) 
 

Free memory ptr and associated memory.

Parameters:
mem Memory to be freed
See also:
ops_memory_release()

ops_memory_clear()

void* ops_memory_get_data ops_memory_t mem  ) 
 

Get data stored in ops_memory_t struct.

Returns:
Pointer to data

size_t ops_memory_get_length const ops_memory_t mem  ) 
 

Get length of data stored in ops_memory_t struct.

Returns:
Number of bytes in data

void ops_memory_init ops_memory_t mem,
size_t  initial_size
 

Memory to initialise.

Parameters:
mem memory to initialise
initial_size Size to initialise to

ops_memory_t* ops_memory_new void   ) 
 

Create a new zeroed ops_memory_t.

Returns:
Pointer to new ops_memory_t
Note:
Free using ops_memory_free() after use.
See also:
ops_memory_free()

void ops_memory_pad ops_memory_t mem,
size_t  length
 

Pad memory to required length.

Parameters:
mem Memory to use
length New size

void ops_memory_release ops_memory_t mem  ) 
 

Free memory and associated data.

Parameters:
mem Memory to free
Note:
This does not free mem itself
See also:
ops_memory_clear()

ops_memory_free()


Generated on Thu May 23 00:00:02 2013 for OpenPGP:SDK by  doxygen 1.4.6