NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_flow_definitions.h File Reference
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <doca_compat.h>
#include <doca_error.h>
Include dependency graph for doca_flow_definitions.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_cfg_create (struct doca_flow_definitions_cfg **defs_cfg)
 Creates a definitions configuration object. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_cfg_destroy (struct doca_flow_definitions_cfg *defs_cfg)
 Destroys a definitions configuration object. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_create (struct doca_flow_definitions_cfg *defs_cfg, struct doca_flow_definitions **defs)
 Creates a definitions object. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_add_field (struct doca_flow_definitions *defs, const char *field_opcode_str, uint32_t field_offset, uint32_t field_length)
 Add a field to the definitions object. More...
 
DOCA_EXPERIMENTAL void doca_flow_definitions_destroy (struct doca_flow_definitions *defs)
 Destroys a definitions object. More...
 

Function Documentation

◆ doca_flow_definitions_add_field()

DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_add_field ( struct doca_flow_definitions *  defs,
const char *  field_opcode_str,
uint32_t  field_offset,
uint32_t  field_length 
)

Add a field to the definitions object.

Parameters
defsPointer to a definitions object.
field_opcode_strPointer to field opcode string.
field_offsetField offset.
field_lengthField length. Return DOCA_SUCCESS on success, doca error otherwise.

◆ doca_flow_definitions_cfg_create()

DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_cfg_create ( struct doca_flow_definitions_cfg **  defs_cfg)

Creates a definitions configuration object.

Parameters
[out]defs_cfgPointer to a definitions configuration.

Return DOCA_SUCCESS on success, doca error otherwise.

◆ doca_flow_definitions_cfg_destroy()

DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_cfg_destroy ( struct doca_flow_definitions_cfg *  defs_cfg)

Destroys a definitions configuration object.

Parameters
[in]defs_cfgPointer to a definitions configuration.

Return DOCA_SUCCESS on success, doca error otherwise.

◆ doca_flow_definitions_create()

DOCA_EXPERIMENTAL doca_error_t doca_flow_definitions_create ( struct doca_flow_definitions_cfg *  defs_cfg,
struct doca_flow_definitions **  defs 
)

Creates a definitions object.

Parameters
[in]defs_cfgPointer to a definitions configuration.
[out]defsPointer to a definitions object pointer. Return DOCA_SUCCESS on success, doca error otherwise.

◆ doca_flow_definitions_destroy()

DOCA_EXPERIMENTAL void doca_flow_definitions_destroy ( struct doca_flow_definitions *  defs)

Destroys a definitions object.

Parameters
defsPointer to a definitions object.