BSL_SeqWriter_t Struct Reference

Definition of a sequential writer using callbacks. More...

#include <bsl/dynamic/SeqReadWrite.h>

Collaboration diagram for BSL_SeqWriter_t:

Data Fields
void *	user_data
	Context from the BPA.
int(*	write )(void *user_data, const void *buf, size_t size)
	Called to read a block of data from the source.
void(*	deinit )(void *user_data, bool success)
	Called to close this writer and free its resources.

Detailed Description

Definition of a sequential writer using callbacks.

Field Documentation

deinit

void(* BSL_SeqWriter_t::deinit) (void *user_data, bool success)

Called to close this writer and free its resources.

This pointer must not be NULL.

Parameters

[in]	user_data	The context pointer.
	success	Set true if all of the writing succeeded and and any backing buffer can be committed by the BPA.

Postcondition

The data written to the block is reflected in later reads and/or block metadata.

user_data

void* BSL_SeqWriter_t::user_data

Context from the BPA.

write

int(* BSL_SeqWriter_t::write) (void *user_data, const void *buf, size_t size)

Called to read a block of data from the source.

This pointer must not be NULL.

Parameters

[in]	user_data	The context pointer.
[in]	buf	The buffer to write from, with its size indicated by size.
	size	The input of the buffer size.

Returns

Zero if successful writing the entire size.

---

The documentation for this struct was generated from the following file:

• src/bsl/dynamic/SeqReadWrite.h