Buffer Stream

Classes
struct	iio_buffer_stream
	An opened buffer ready for data streaming. More...

Functions
struct iio_buffer_stream *	iio_buffer_open (struct iio_buffer *buf, const struct iio_channels_mask *mask)
	Open a buffer for data streaming.
void	iio_buffer_close (struct iio_buffer_stream *buf_stream)
	Close a buffer stream.
void	iio_buffer_stream_cancel (struct iio_buffer_stream *buf_stream)
	Cancel all buffer stream operations.
int	iio_buffer_stream_start (struct iio_buffer_stream *buf_stream)
	Start the buffer stream.
int	iio_buffer_stream_stop (struct iio_buffer_stream *buf_stream)
	Stop the buffer stream.
const struct iio_channels_mask *	iio_buffer_stream_get_channels_mask (const struct iio_buffer_stream *buf_stream)
	Retrieve the channels mask of a buffer stream.

Detailed Description

Function Documentation

iio_buffer_close()

void iio_buffer_close

(

struct iio_buffer_stream *

buf_stream

)

Close a buffer stream.

Parameters

buf_stream

A pointer to an iio_buffer_stream structure

iio_buffer_open()

struct iio_buffer_stream * iio_buffer_open	(	struct iio_buffer *	buf,
		const struct iio_channels_mask *	mask )

Open a buffer for data streaming.

Parameters

buf	A pointer to an iio_buffer structure
mask	A pointer to an iio_channels_mask structure specifying which channels to enable

Returns

On success, a pointer to an iio_buffer_stream structure

On failure, a pointer-encoded error is returned

iio_buffer_stream_cancel()

void iio_buffer_stream_cancel

(

struct iio_buffer_stream *

buf_stream

)

Cancel all buffer stream operations.

Parameters

buf_stream

The buffer stream for which operations should be canceled

iio_buffer_stream_get_channels_mask()

const struct iio_channels_mask * iio_buffer_stream_get_channels_mask

(

const struct iio_buffer_stream *

buf_stream

)

Retrieve the channels mask of a buffer stream.

Parameters

buf_stream

A pointer to an iio_buffer_stream structure

Returns

A pointer to an iio_channels_mask structure

iio_buffer_stream_start()

int iio_buffer_stream_start

(

struct iio_buffer_stream *

buf_stream

)

Start the buffer stream.

Parameters

buf_stream

A pointer to an iio_buffer_stream structure

Returns

On success, 0

On error, a negative error code is returned

iio_buffer_stream_stop()

int iio_buffer_stream_stop

(

struct iio_buffer_stream *

buf_stream

)

Stop the buffer stream.

Parameters

buf_stream

A pointer to an iio_buffer_stream structure

Returns

On success, 0

On error, a negative error code is returned