dynamic_buffer_stream_cr_api.h File Reference

Composition Root API for the dynamic_buffer_stream adapter. More...

#include "dynamic_buffer_stream/cr/dynamic_buffer_stream_types.h"
#include "stream/borrowers/stream_types.h"
#include "stream/adapters/stream_key_type.h"
#include "stream/adapters/stream_install.h"
#include "stream/adapters/stream_adapters_api.h"

Include dependency graph for dynamic_buffer_stream_cr_api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
dynamic_buffer_stream_cfg_t	dynamic_buffer_stream_default_cfg (void)
	Return the default configuration for the dynamic_buffer_stream adapter.
dynamic_buffer_stream_env_t	dynamic_buffer_stream_default_env (const osal_mem_ops_t *mem, const stream_env_t *port_env)
	Return the default injected environment for the dynamic_buffer_stream adapter.
stream_status_t	dynamic_buffer_stream_create_stream (stream_t **out, const dynamic_buffer_stream_cfg_t *cfg, const dynamic_buffer_stream_env_t *env)
	Create a dynamic_buffer_stream instance directly.
stream_status_t	dynamic_buffer_stream_create_desc (stream_adapter_desc_t *out, stream_key_t key, const dynamic_buffer_stream_cfg_t *cfg, const dynamic_buffer_stream_env_t *env, const osal_mem_ops_t *mem)
	Build a stream adapter descriptor for the dynamic_buffer_stream adapter.
stream_status_t	dynamic_buffer_stream_ctor (const void *ud, const void *args, stream_t **out)
	Factory-compatible constructor callback for the dynamic_buffer_stream adapter.

Detailed Description

This header exposes the CR-facing services used to configure, construct, and register the dynamic_buffer_stream adapter.

Definition in file dynamic_buffer_stream_cr_api.h.

Function Documentation

dynamic_buffer_stream_create_desc()

stream_status_t dynamic_buffer_stream_create_desc	(	stream_adapter_desc_t *	out,
		stream_key_t	key,
		const dynamic_buffer_stream_cfg_t *	cfg,
		const dynamic_buffer_stream_env_t *	env,
		const osal_mem_ops_t *	mem
	)

Parameters

out	Output location that receives the constructed adapter descriptor on success.
key	Borrowed adapter registration key.
cfg	Borrowed adapter configuration copied into descriptor-owned constructor data.
env	Borrowed adapter environment copied into descriptor-owned constructor data.
mem	Borrowed memory operations table used to allocate the descriptor-owned constructor data.

Return values

STREAM_STATUS_OK	The descriptor was created successfully.
STREAM_STATUS_INVALID	One or more arguments are invalid.
STREAM_STATUS_OOM	Memory allocation failed.

The descriptor produced by this function is intended to be registered into a stream factory. The constructor user data allocated for that descriptor is owned by the descriptor lifecycle and must therefore use the factory memory operations.

Definition at line 313 of file dynamic_buffer_stream.c.

dynamic_buffer_stream_create_stream()

stream_status_t dynamic_buffer_stream_create_stream	(	stream_t **	out,
		const dynamic_buffer_stream_cfg_t *	cfg,
		const dynamic_buffer_stream_env_t *	env
	)

Parameters

out	Output location that receives the created stream_t * on success.
cfg	Borrowed adapter configuration.
env	Borrowed adapter environment.

Return values

STREAM_STATUS_OK	The stream was created successfully.
STREAM_STATUS_INVALID	One or more arguments are invalid.
STREAM_STATUS_OOM	Memory allocation failed.

Definition at line 260 of file dynamic_buffer_stream.c.

dynamic_buffer_stream_ctor()

stream_status_t dynamic_buffer_stream_ctor	(	const void *	ud,
		const void *	args,
		stream_t **	out
	)

Parameters

ud	Borrowed adapter-specific constructor user data.
args	Borrowed creation arguments expected by the adapter factory contract.
out	Output location that receives the created stream_t * on success.

Return values

STREAM_STATUS_OK	The stream was created successfully.
STREAM_STATUS_INVALID	One or more arguments are invalid.
STREAM_STATUS_OOM	Memory allocation failed.

Definition at line 287 of file dynamic_buffer_stream.c.

dynamic_buffer_stream_default_cfg()

dynamic_buffer_stream_cfg_t dynamic_buffer_stream_default_cfg

(

void

)

Returns

Default adapter configuration value.

Definition at line 356 of file dynamic_buffer_stream.c.

dynamic_buffer_stream_default_env()

dynamic_buffer_stream_env_t dynamic_buffer_stream_default_env	(	const osal_mem_ops_t *	mem,
		const stream_env_t *	port_env
	)

Parameters

mem	Borrowed memory operations table used by the adapter backend.
port_env	Borrowed stream port environment to forward to stream_create().

Returns

Default adapter environment value.

Definition at line 363 of file dynamic_buffer_stream.c.