DOCA Flow Tune Server

Collaboration diagram for DOCA Flow Tune Server:

Functions
DOCA_EXPERIMENTAL doca_error_t	doca_flow_tune_server_cfg_create (struct doca_flow_tune_server_cfg **cfg)
	Create DOCA Flow Tune Server configuration struct. More...
DOCA_EXPERIMENTAL doca_error_t	doca_flow_tune_server_cfg_set_cfg_file_path (struct doca_flow_tune_server_cfg *cfg, const char *path)
	Set Tune Server configuration file path. More...
DOCA_EXPERIMENTAL doca_error_t	doca_flow_tune_server_cfg_destroy (struct doca_flow_tune_server_cfg *cfg)
	Destroy DOCA Flow Tune Server configuration struct. More...
DOCA_EXPERIMENTAL doca_error_t	doca_flow_tune_server_init (struct doca_flow_tune_server_cfg *cfg)
	Initialize a DOCA Flow Tune Server. More...
DOCA_EXPERIMENTAL void	doca_flow_tune_server_destroy (void)
	Destroy the DOCA Flow Tune Server. More...

Detailed Description

Function Documentation

doca_flow_tune_server_cfg_create()

DOCA_EXPERIMENTAL doca_error_t doca_flow_tune_server_cfg_create

(

struct doca_flow_tune_server_cfg **

cfg

)

Create DOCA Flow Tune Server configuration struct.

Parameters

[out]

cfg

DOCA Flow Tune Server global configuration ptr address.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

• DOCA_ERROR_NO_MEMORY - memory allocation failed.

doca_flow_tune_server_cfg_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_flow_tune_server_cfg_destroy

(

struct doca_flow_tune_server_cfg *

cfg

)

Destroy DOCA Flow Tune Server configuration struct.

Parameters

[in]

cfg

DOCA Flow Tune Server global configuration.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

• DOCA_ERROR_INVALID_VALUE - received invalid input.

doca_flow_tune_server_cfg_set_cfg_file_path()

DOCA_EXPERIMENTAL doca_error_t doca_flow_tune_server_cfg_set_cfg_file_path	(	struct doca_flow_tune_server_cfg *	cfg,
		const char *	path
	)

Set Tune Server configuration file path.

Parameters

[in]	cfg	DOCA Flow Tune Server global configuration.
[in]	path	Configuration file path.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

• DOCA_ERROR_INVALID_VALUE - received invalid input.

doca_flow_tune_server_destroy()

DOCA_EXPERIMENTAL void doca_flow_tune_server_destroy

(

void

)

Destroy the DOCA Flow Tune Server.

Release all the resources used by DOCA Flow Tune Server. Should be invoked before doca_flow_destroy() upon application termination.

doca_flow_tune_server_init()

DOCA_EXPERIMENTAL doca_error_t doca_flow_tune_server_init

(

struct doca_flow_tune_server_cfg *

cfg

)

Initialize a DOCA Flow Tune Server.

This is the global initialization function for DOCA Flow Tune Server. It initializes all resources used by DOCA Flow Tune Server.

Should be called after doca_flow_init().

Parameters

[in]

cfg

DOCA Flow Tune Server global configuration.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

• DOCA_ERROR_NOT_SUPPORTED - functionality isn't supported in this (runtime) version.
• DOCA_ERROR_INVALID_VALUE - received invalid input.
• DOCA_ERROR_UNKNOWN - otherwise.