Typedefs
typedef doca_error_t(*	doca_argp_param_cb_t) (void , void )
	Flag callback function type. More...

typedef doca_error_t(*	doca_argp_cmd_cb_t) (void *)
	Cmd callback function type. More...

typedef doca_error_t(*	doca_argp_dpdk_cb_t) (int argc, char **argv)
	DPDK flags callback function type. More...

typedef doca_error_t(*	doca_argp_validation_cb_t) (void *)
	Program validation callback function type. More...

typedef doca_error_t(*	doca_argp_logger_cb_t) (enum doca_log_level level, const char *format, va_list args)
	(Operational) Logger callback function type More...

Enumerations
enum	doca_argp_type { DOCA_ARGP_TYPE_UNKNOWN = 0 , DOCA_ARGP_TYPE_STRING , DOCA_ARGP_TYPE_INT , DOCA_ARGP_TYPE_BOOLEAN , DOCA_ARGP_TYPE_JSON_OBJ }
	Flag input type. More...

Functions
DOCA_EXPERIMENTAL void	doca_argp_usage (void)
	Print usage instructions. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_init (const char program_name, void program_config)
	Initialize the parser interface. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_register_param (struct doca_argp_param *input_param)
	Register a program flag. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_register_cmd (struct doca_argp_cmd *input_cmd)
	Register a program command. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_register_version_callback (doca_argp_param_cb_t callback)
	Register an alternative version callback. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_register_validation_callback (doca_argp_validation_cb_t callback)
	Register program validation callback function. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_register_logger_callback (doca_argp_logger_cb_t callback)
	Register a logger callback to be used for user-facing events. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_disable_logger_callback (void)
	Disable a previously registered logger callback, reverting back to default stderr backend. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_start (int argc, char **argv)
	Parse incoming arguments (cmd line/json). More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_destroy (void)
	ARG Parser destroy. More...

DOCA_EXPERIMENTAL void	doca_argp_set_dpdk_program (doca_argp_dpdk_cb_t callback)
	Mark the program as based on DPDK API. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_param_create (struct doca_argp_param **param)
	Create new program param. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_short_name (struct doca_argp_param param, const char name)
	Set the short name of the program param. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_long_name (struct doca_argp_param param, const char name)
	Set the long name of the program param. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_arguments (struct doca_argp_param param, const char arguments)
	Set the description of the expected arguments of the program param, used during program usage. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_description (struct doca_argp_param param, const char description)
	Set the description of the program param, used during program usage. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_callback (struct doca_argp_param *param, doca_argp_param_cb_t callback)
	Set the callback function of the program param. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_type (struct doca_argp_param *param, enum doca_argp_type type)
	Set the type of the param arguments. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_mandatory (struct doca_argp_param *param)
	Mark the program param as mandatory. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_cli_only (struct doca_argp_param *param)
	Mark the program param as supported only in CLI mode and unavailable through a JSON file. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_multiplicity (struct doca_argp_param *param)
	Mark the program param as supporting multiple appearances. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_singular (struct doca_argp_param *param)
	Mark the program param as singular. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_inherited (struct doca_argp_param *param)
	Mark the program param as inherited through the command chain. More...

DOCA_EXPERIMENTAL void	doca_argp_param_set_hidden (struct doca_argp_param *param)
	Mark the program param as hidden. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_param_destroy (struct doca_argp_param *param)
	Destroy a program param. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_cmd_create (struct doca_argp_cmd **cmd)
	Create new program command. More...

DOCA_EXPERIMENTAL void	doca_argp_cmd_set_name (struct doca_argp_cmd cmd, const char name)
	Set the name of the program command. More...

DOCA_EXPERIMENTAL void	doca_argp_cmd_set_description (struct doca_argp_cmd cmd, const char description)
	Set the description of the program command, used during the program usage. More...

DOCA_EXPERIMENTAL void	doca_argp_cmd_set_callback (struct doca_argp_cmd *cmd, doca_argp_cmd_cb_t callback)
	Set the callback function of the program command. More...

DOCA_EXPERIMENTAL void	doca_argp_cmd_set_hidden (struct doca_argp_cmd *cmd)
	Mark the program command as hidden. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_cmd_register_param (struct doca_argp_cmd cmd, struct doca_argp_param input_param)
	Register a program flag for the given program command. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_cmd_register_cmd (struct doca_argp_cmd cmd, struct doca_argp_cmd input_cmd)
	Register an inner program command for the given program command. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_cmd_destroy (struct doca_argp_cmd *cmd)
	Destroy a program command. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_get_log_level (int *log_level)
	Get the log level the user inserted it. More...

DOCA_EXPERIMENTAL doca_error_t	doca_argp_get_sdk_log_level (int *log_level)
	Get the SDK log level as passed by the user. More...

Detailed Description

DOCA Arg Parser library. For more details please refer to the user guide on DOCA DevZone.

Typedef Documentation

◆ doca_argp_cmd_cb_t

typedef doca_error_t(* doca_argp_cmd_cb_t) (void *)

Cmd callback function type.

Definition at line 40 of file doca_argp.h.

◆ doca_argp_dpdk_cb_t

typedef doca_error_t(* doca_argp_dpdk_cb_t) (int argc, char **argv)

DPDK flags callback function type.

Definition at line 43 of file doca_argp.h.

◆ doca_argp_logger_cb_t

typedef doca_error_t(* doca_argp_logger_cb_t) (enum doca_log_level level, const char *format, va_list args)

(Operational) Logger callback function type

Definition at line 49 of file doca_argp.h.

◆ doca_argp_param_cb_t

typedef doca_error_t(* doca_argp_param_cb_t) (void *, void *)

Flag callback function type.

Definition at line 37 of file doca_argp.h.

◆ doca_argp_validation_cb_t

typedef doca_error_t(* doca_argp_validation_cb_t) (void *)

Program validation callback function type.

Definition at line 46 of file doca_argp.h.

Enumeration Type Documentation

◆ doca_argp_type

enum doca_argp_type

Flag input type.

Enumerator
DOCA_ARGP_TYPE_UNKNOWN
DOCA_ARGP_TYPE_STRING	Input type is a string
DOCA_ARGP_TYPE_INT	Input type is an integer
DOCA_ARGP_TYPE_BOOLEAN	Input type is a boolean
DOCA_ARGP_TYPE_JSON_OBJ	DPDK Param input type is a json object, only for json mode

Definition at line 54 of file doca_argp.h.

Function Documentation

◆ doca_argp_cmd_create()

DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_create ( struct doca_argp_cmd ** cmd )

Create new program command.

Parameters

[out] cmd Create program command instance on success. Valid on success only.

Note: Need to set command fields by setter functions.

Returns

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

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate enough space.
DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed.

◆ doca_argp_cmd_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_destroy ( struct doca_argp_cmd * cmd )

Destroy a program command.

Parameters

[in] cmd The program command to destroy.

Returns

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

DOCA_ERROR_BAD_STATE - command was already registered.
DOCA_ERROR_INVALID_VALUE - invalid input received.

◆ doca_argp_cmd_register_cmd()

DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_register_cmd	(	struct doca_argp_cmd *	cmd,
		struct doca_argp_cmd *	input_cmd
	)

Register an inner program command for the given program command.

Parameters

[in]	cmd	The program command.
[in]	input_cmd	Inner program command details.

Returns

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

DOCA_ERROR_BAD_STATE - one of the commands was already registered.
DOCA_ERROR_INITIALIZATION - received command with missing mandatory fields initialization.
DOCA_ERROR_INVALID_VALUE - received invalid input.

Note: ARGP takes ownership of the pointer in ALL flows, and is responsible for later destroying it.

◆ doca_argp_cmd_register_param()

DOCA_EXPERIMENTAL doca_error_t doca_argp_cmd_register_param	(	struct doca_argp_cmd *	cmd,
		struct doca_argp_param *	input_param
	)

Register a program flag for the given program command.

Parameters

[in]	cmd	The program command.
[in]	input_param	Program flag details.

Returns

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

DOCA_ERROR_BAD_STATE - command or parameter were already registered.
DOCA_ERROR_INITIALIZATION - received param with missing mandatory fields.
DOCA_ERROR_INVALID_VALUE - received invalid input.

Note: Value of is_cli_only field may be changed in this function.; ARGP takes ownership of the pointer in ALL flows, and is responsible for later destroying it.

◆ doca_argp_cmd_set_callback()

DOCA_EXPERIMENTAL void doca_argp_cmd_set_callback	(	struct doca_argp_cmd *	cmd,
		doca_argp_cmd_cb_t	callback
	)

Set the callback function of the program command.

Parameters

[in]	cmd	The program command.
[in]	callback	The command's callback function.

Note: Passing a "cmd" value of NULL will result in an undefined behavior.; Once ARGP identifies this command in CLI, it will call the callback function with the program configuration struct.; Providing a callback is optional, and is recommended for the leaves in the cmd tree.

◆ doca_argp_cmd_set_description()

DOCA_EXPERIMENTAL void doca_argp_cmd_set_description	(	struct doca_argp_cmd *	cmd,
		const char *	description
	)

Set the description of the program command, used during the program usage.

Parameters

[in]	cmd	The program command.
[in]	description	The command's description.

Note: Passing a "cmd" value of NULL will result in an undefined behavior.; Setting the command description is mandatory.

◆ doca_argp_cmd_set_hidden()

DOCA_EXPERIMENTAL void doca_argp_cmd_set_hidden ( struct doca_argp_cmd * cmd )

Mark the program command as hidden.

Parameters

[in] cmd The program command.

Note: Passing a "cmd" value of NULL will result in an undefined behavior.

◆ doca_argp_cmd_set_name()

DOCA_EXPERIMENTAL void doca_argp_cmd_set_name	(	struct doca_argp_cmd *	cmd,
		const char *	name
	)

Set the name of the program command.

Parameters

[in]	cmd	The program command.
[in]	name	The command's name.

Note: Passing a "cmd" value of NULL will result in an undefined behavior.; Setting the command name is mandatory.

◆ doca_argp_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_argp_destroy ( void )

ARG Parser destroy.

Cleanup all resources, including the parsed DPDK flags. Once called, the module is no longer useable.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed.

◆ doca_argp_disable_logger_callback()

DOCA_EXPERIMENTAL doca_error_t doca_argp_disable_logger_callback ( void )

Disable a previously registered logger callback, reverting back to default stderr backend.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized, was already destroyed or no callback was registered.

◆ doca_argp_get_log_level()

DOCA_EXPERIMENTAL doca_error_t doca_argp_get_log_level ( int * log_level )

Get the log level the user inserted it.

Parameters

[out] log_level The log level if passed by the user, otherwise the global value of the program.

Returns

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

DOCA_ERROR_INVALID_VALUE - invalid input received.

◆ doca_argp_get_sdk_log_level()

DOCA_EXPERIMENTAL doca_error_t doca_argp_get_sdk_log_level ( int * log_level )

Get the SDK log level as passed by the user.

Parameters

[out] log_level The log level if passed by the user, otherwise the global value of the program.

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

DOCA_ERROR_INVALID_VALUE - invalid input received.

◆ doca_argp_init()

DOCA_EXPERIMENTAL doca_error_t doca_argp_init	(	const char *	program_name,
		void *	program_config
	)

Initialize the parser interface.

Parameters

[in]	program_name	(Optional) Name of current program, used during the usage print.
[in]	program_config	Program configuration struct.

Returns

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

DOCA_ERROR_BAD_STATE - module was already initialized earlier.
DOCA_ERROR_NO_MEMORY - failed to allocate enough space.
DOCA_ERROR_INVALID_VALUE - received invalid input.

Note: After a successful call to this function, one must also invoke doca_argp_destroy() during the program cleanup.; If no program name is passed, name will be extracted from argv as passed to doca_argp_start().

◆ doca_argp_param_create()

DOCA_EXPERIMENTAL doca_error_t doca_argp_param_create ( struct doca_argp_param ** param )

Create new program param.

Parameters

[out] param Created program param instance. Valid only on success.

Note: Param fields should be set through the setter functions.

Returns

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

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate enough space.
DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed.

◆ doca_argp_param_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_argp_param_destroy ( struct doca_argp_param * param )

Destroy a program param.

Parameters

[in] param The program param to destroy.

Returns

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

DOCA_ERROR_BAD_STATE - parameter was already registered.
DOCA_ERROR_INVALID_VALUE - invalid input received.

◆ doca_argp_param_set_arguments()

DOCA_EXPERIMENTAL void doca_argp_param_set_arguments	(	struct doca_argp_param *	param,
		const char *	arguments
	)

Set the description of the expected arguments of the program param, used during program usage.

Parameters

[in]	param	The program param.
[in]	arguments	The param's arguments.

Note: Passing a "param" value of NULL will result in an undefined behavior.

◆ doca_argp_param_set_callback()

DOCA_EXPERIMENTAL void doca_argp_param_set_callback	(	struct doca_argp_param *	param,
		doca_argp_param_cb_t	callback
	)

Set the callback function of the program param.

Parameters

[in]	param	The program param.
[in]	callback	The param's callback function.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Once ARGP identifies this param in CLI, it will call the callback function with the param argument value as first argument followed by the program configuration struct. Program must copy the argument value and shouldn't use it directly once the callback finished.; Setting the param callback is mandatory.

◆ doca_argp_param_set_cli_only()

DOCA_EXPERIMENTAL void doca_argp_param_set_cli_only ( struct doca_argp_param * param )

Mark the program param as supported only in CLI mode and unavailable through a JSON file.

Parameters

[in] param The program param.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Parameters are by default available in both modes, as long as they have a long name.

◆ doca_argp_param_set_description()

DOCA_EXPERIMENTAL void doca_argp_param_set_description	(	struct doca_argp_param *	param,
		const char *	description
	)

Set the description of the program param, used during program usage.

Parameters

[in]	param	The program param.
[in]	description	The param's description.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Setting the param description is mandatory.

◆ doca_argp_param_set_hidden()

DOCA_EXPERIMENTAL void doca_argp_param_set_hidden ( struct doca_argp_param * param )

Mark the program param as hidden.

Parameters

[in] param The program param.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Parameters are only valid for the current command by default.

◆ doca_argp_param_set_inherited()

DOCA_EXPERIMENTAL void doca_argp_param_set_inherited ( struct doca_argp_param * param )

Mark the program param as inherited through the command chain.

Parameters

[in] param The program param.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Parameters are only valid for the current command by default.

◆ doca_argp_param_set_long_name()

DOCA_EXPERIMENTAL void doca_argp_param_set_long_name	(	struct doca_argp_param *	param,
		const char *	name
	)

Set the long name of the program param.

Parameters

[in]	param	The program param.
[in]	name	The param's long name.

Note: Passing a "param" value of NULL will result in an undefined behavior.; At least one of param name (short/long) must be set.

◆ doca_argp_param_set_mandatory()

DOCA_EXPERIMENTAL void doca_argp_param_set_mandatory ( struct doca_argp_param * param )

Mark the program param as mandatory.

Parameters

[in] param The program param.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Parameters are optional by default.

◆ doca_argp_param_set_multiplicity()

DOCA_EXPERIMENTAL void doca_argp_param_set_multiplicity ( struct doca_argp_param * param )

Mark the program param as supporting multiple appearances.

Parameters

[in] param The program param.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Since JSON file doesn't support keys multiplicity, the multi values will be expected to be in an array, and param argument type will indicate the values type.; Parameters can only be used once by default.

◆ doca_argp_param_set_short_name()

DOCA_EXPERIMENTAL void doca_argp_param_set_short_name	(	struct doca_argp_param *	param,
		const char *	name
	)

Set the short name of the program param.

Parameters

[in]	param	The program param.
[in]	name	The param's short name

Note: Passing a "param" value of NULL will result in an undefined behavior.; At least one of param name (short/long) must be set.

◆ doca_argp_param_set_singular()

DOCA_EXPERIMENTAL void doca_argp_param_set_singular ( struct doca_argp_param * param )

Mark the program param as singular.

Parameters

[in] param The program param.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Singular parameters must not be passed alongside any other parameter.; Parameters can be used alongside others by default.

◆ doca_argp_param_set_type()

DOCA_EXPERIMENTAL void doca_argp_param_set_type	(	struct doca_argp_param *	param,
		enum doca_argp_type	type
	)

Set the type of the param arguments.

Parameters

[in]	param	The program param.
[in]	type	The param arguments type.

Note: Passing a "param" value of NULL will result in an undefined behavior.; Setting the param arguments type is mandatory.

◆ doca_argp_register_cmd()

DOCA_EXPERIMENTAL doca_error_t doca_argp_register_cmd ( struct doca_argp_cmd * input_cmd )

Register a program command.

Parameters

[in] input_cmd Program cmd/mode details.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed, or cmd was already registered.
DOCA_ERROR_INITIALIZATION - received command with missing mandatory fields initialization.
DOCA_ERROR_INVALID_VALUE - received invalid input.

Note: ARGP takes ownership of the pointer in ALL flows, and is responsible for later destroying it.

◆ doca_argp_register_logger_callback()

DOCA_EXPERIMENTAL doca_error_t doca_argp_register_logger_callback ( doca_argp_logger_cb_t callback )

Register a logger callback to be used for user-facing events.

Parameters

[in] callback logging callback for operational log events.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed.
DOCA_ERROR_ALREADY_EXIST - callback was already registered earlier.
DOCA_ERROR_INVALID_VALUE - received invalid input.

◆ doca_argp_register_param()

DOCA_EXPERIMENTAL doca_error_t doca_argp_register_param ( struct doca_argp_param * input_param )

Register a program flag.

Parameters

[in] input_param Program flag details.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed, or param was already registered.
DOCA_ERROR_INITIALIZATION - received param with missing mandatory fields.
DOCA_ERROR_INVALID_VALUE - received invalid input.

Note: Value of is_cli_only field may be changed in this function.; ARGP takes ownership of the pointer in ALL flows, and is responsible for later destroying it.

◆ doca_argp_register_validation_callback()

DOCA_EXPERIMENTAL doca_error_t doca_argp_register_validation_callback ( doca_argp_validation_cb_t callback )

Register program validation callback function.

Parameters

[in] callback Program validation callback.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed.
DOCA_ERROR_INVALID_VALUE - received invalid input.

Note: Validation callback will be invoked with a single argument, which is the program's configuration struct.

◆ doca_argp_register_version_callback()

DOCA_EXPERIMENTAL doca_error_t doca_argp_register_version_callback ( doca_argp_param_cb_t callback )

Register an alternative version callback.

Parameters

[in] callback Program-specific version callback.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed.
DOCA_ERROR_INVALID_VALUE - received invalid input.

Note: : When calling the version callback, if the program will exit, should ensure that doca_argp_destroy is called to clean up doca_argp before exiting

◆ doca_argp_set_dpdk_program()

DOCA_EXPERIMENTAL void doca_argp_set_dpdk_program ( doca_argp_dpdk_cb_t callback )

Mark the program as based on DPDK API.

Parameters

[in] callback Once ARGP finishes parsing, the DPDK flags will be forwarded to the program through this callback.

Note: doca_argp_init must be invoked before invoking this function.; If the program is based on DPDK API, DPDK flags array will be sent using the callback, and the array will be released when calling doca_argp_destroy.

◆ doca_argp_start()

DOCA_EXPERIMENTAL doca_error_t doca_argp_start	(	int	argc,
		char **	argv
	)

Parse incoming arguments (cmd line/json).

Parameters

[in]	argc	Number of program command line arguments.
[in]	argv	Program command line arguments.

Returns

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

DOCA_ERROR_BAD_STATE - module wasn't yet initialized or was already destroyed.
DOCA_ERROR_INITIALIZATION - initialization error.
DOCA_ERROR_IO_FAILED - internal errors about JSON API, reading JSON content.
DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_NO_MEMORY - failed to allocate enough space.
DOCA_ERROR_NOT_SUPPORTED - received unsupported program flag.

Note: : if the program is based on DPDK API, DPDK flags will be forwarded to it by calling the registered callback.

◆ doca_argp_usage()

DOCA_EXPERIMENTAL void doca_argp_usage ( void )

Print usage instructions.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ doca_argp_cmd_cb_t

◆ doca_argp_dpdk_cb_t

◆ doca_argp_logger_cb_t

◆ doca_argp_param_cb_t

◆ doca_argp_validation_cb_t

Enumeration Type Documentation

◆ doca_argp_type

Function Documentation

◆ doca_argp_cmd_create()

◆ doca_argp_cmd_destroy()

◆ doca_argp_cmd_register_cmd()

◆ doca_argp_cmd_register_param()

◆ doca_argp_cmd_set_callback()

◆ doca_argp_cmd_set_description()

◆ doca_argp_cmd_set_hidden()

◆ doca_argp_cmd_set_name()

◆ doca_argp_destroy()

◆ doca_argp_disable_logger_callback()

◆ doca_argp_get_log_level()

◆ doca_argp_get_sdk_log_level()

◆ doca_argp_init()

◆ doca_argp_param_create()

◆ doca_argp_param_destroy()

◆ doca_argp_param_set_arguments()

◆ doca_argp_param_set_callback()

◆ doca_argp_param_set_cli_only()

◆ doca_argp_param_set_description()

◆ doca_argp_param_set_hidden()

◆ doca_argp_param_set_inherited()

◆ doca_argp_param_set_long_name()

◆ doca_argp_param_set_mandatory()

◆ doca_argp_param_set_multiplicity()

◆ doca_argp_param_set_short_name()

◆ doca_argp_param_set_singular()

◆ doca_argp_param_set_type()

◆ doca_argp_register_cmd()

◆ doca_argp_register_logger_callback()

◆ doca_argp_register_param()

◆ doca_argp_register_validation_callback()

◆ doca_argp_register_version_callback()

◆ doca_argp_set_dpdk_program()

◆ doca_argp_start()

◆ doca_argp_usage()