Create/Close/Start Real-Time Streams
[Generic Block Interface Client API]

Handling of real-time streams. More...

Defines
#define	L4BLK_INVALID_STREAM   (-1)
Typedefs
typedef l4_uint32_t	l4blk_stream_t
Functions
L4_CV int	l4blk_create_stream (l4blk_driver_t driver, l4_uint32_t device, l4_uint32_t bandwidth, l4_uint32_t period, l4_uint32_t blk_size, float q, l4_uint32_t meta_int, l4blk_stream_t *stream)
	Create real-time stream.
L4_CV int	l4blk_close_stream (l4blk_driver_t driver, l4blk_stream_t stream)
	Close real-time stream.
L4_CV int	l4blk_start_stream (l4blk_driver_t driver, l4blk_stream_t stream, l4_uint32_t time, l4_uint32_t request_no)
	Set start time of real-time stream.

---

Detailed Description

Handling of real-time streams.

---

Define Documentation

#define L4BLK_INVALID_STREAM   (-1)

Invalid stream handle

Definition at line 199 of file types.h.

---

Typedef Documentation

typedef l4_uint32_t l4blk_stream_t

Stream handle

Definition at line 46 of file types.h.

---

Function Documentation

L4_CV int l4blk_create_stream	(	l4blk_driver_t	driver,
		l4_uint32_t	device,
		l4_uint32_t	bandwidth,
		l4_uint32_t	period,
		l4_uint32_t	blk_size,
		float	q,
		l4_uint32_t	meta_int,
		l4blk_stream_t *	stream
	)

Create real-time stream.

Parameters:

	driver	Driver handle
	device	Device id
	bandwidth	Stream bandwidth (bytes/s)
	period	Period length (milliseconds)
	blk_size	Stream block size (bytes)
	q	Quality parameter
	meta_int	Metadata request interval (number of regular requests per metadata request)

Return values:

stream

Stream handle

Returns:

0 on success (admission succeeded, stream contains a valid handle), error code otherwise. The error code depends on the driver.

Create real-time stream. If the driver can handle the requested stream, it reserves the requeired resources and returns a valid stream handle.

L4_CV int l4blk_close_stream	(	l4blk_driver_t	driver,
		l4blk_stream_t	stream
	)

Close real-time stream.

Parameters:

	driver	Driver handle
	stream	Stream handle

Returns:

0 on success (stream closed), error code otherwise.

Close real-time stream, release all resources assigned to the stream.

L4_CV int l4blk_start_stream	(	l4blk_driver_t	driver,
		l4blk_stream_t	stream,
		l4_uint32_t	time,
		l4_uint32_t	request_no
	)

Set start time of real-time stream.

Parameters:

	driver	Driver handle
	stream	Stream handle
	time	Time (deadline) of first request (milliseconds)
	request_no	Request number of first request

Returns:

Time of first period on success, error code otherwise.