Cross-platform C SDK logo

Cross-platform C SDK

Buffers

❮ Back
Next ❯
This page has been automatically translated using the Google Translate API services. We are working on improving texts. Thank you for your understanding and patience.

Generic memory blocks, dynamically reserved.


Functions

Buffer*buffer_create (...)
voidbuffer_destroy (...)
uint32_tbuffer_size (...)
byte_t*buffer_data (...)

Buffer objects are simply dynamically stored memory blocks and stored in the Heap Segment. They are useful for sharing generic data between different functions or threads. For the latter case, they must be protected by a Mutex if several threads can access it concurrently (they are not thread-safe). They are of fixed size. Once created, they can not be resized, although they can be rewritten as many times as necessary.


buffer_create ()

Create a new buffer.

Buffer*
buffer_create(const uint32_t size);
size

Buffer size in bytes.

Return

The new buffer.


buffer_destroy ()

Destroy the buffer.

void
buffer_destroy(Buffer **buffer);
buffer

The buffer. It will be set to NULL after the destruction.


buffer_size ()

Gets the size of the buffer.

uint32_t
buffer_size(const Buffer *buffer);
buffer

Buffer.

Return

The size of the buffer in bytes.


buffer_data ()

Gets a pointer to the contents of the buffer.

byte_t*
buffer_data(Buffer *buffer);
buffer

Buffer.

Return

Pointer to the contents of the buffer that can be used to read or write.

❮ Back
Next ❯