UROM Worker plugin interface. More...

#include <doca_urom_plugin.h>

Data Fields
	DOCA_STRUCT_START

doca_error_t(*	open )(struct urom_worker_ctx *ctx)

void(*	close )(struct urom_worker_ctx *ctx)

doca_error_t(*	addr )(struct urom_worker_ctx ctx, void addr, size_t *addr_len)

doca_error_t(*	worker_cmd )(struct urom_worker_ctx ctx, ucs_list_link_t cmd_list)

doca_error_t(*	progress )(struct urom_worker_ctx ctx, ucs_list_link_t notif_list)

doca_error_t(*	notif_pack )(struct urom_worker_notify notif, size_t packed_notif_len, void *packed_notif)

Detailed Description

UROM Worker plugin interface.

Definition at line 108 of file doca_urom_plugin.h.

Field Documentation

◆ addr

doca_error_t(* urom_plugin_iface::addr) (struct urom_worker_ctx *ctx, void *addr, size_t *addr_len)

Return address of worker component.

Definition at line 127 of file doca_urom_plugin.h.

◆ close

void(* urom_plugin_iface::close) (struct urom_worker_ctx *ctx)

Close worker plugin context.

Definition at line 122 of file doca_urom_plugin.h.

◆ DOCA_STRUCT_START

urom_plugin_iface::DOCA_STRUCT_START

Store which DOCA API version the plugin is compiled with.

Definition at line 112 of file doca_urom_plugin.h.

◆ notif_pack

doca_error_t(* urom_plugin_iface::notif_pack) (struct urom_worker_notify *notif, size_t *packed_notif_len, void *packed_notif)

Pack a worker notification before sending on the wire.

Definition at line 148 of file doca_urom_plugin.h.

◆ open

doca_error_t(* urom_plugin_iface::open) (struct urom_worker_ctx *ctx)

Open worker plugin context, including resources initialization.

Definition at line 117 of file doca_urom_plugin.h.

◆ progress

doca_error_t(* urom_plugin_iface::progress) (struct urom_worker_ctx *ctx, ucs_list_link_t *notif_list)

Progress the worker component and add notifications to the end of notif_list.

Caller is responsible to free each entry in notif_list.

Note: : if there is no notification should return DOCA_ERROR_EMPTY

Definition at line 143 of file doca_urom_plugin.h.

◆ worker_cmd

doca_error_t(* urom_plugin_iface::worker_cmd) (struct urom_worker_ctx *ctx, ucs_list_link_t *cmd_list)

Process worker commands.

Worker is responsible to free each entry removed from cmd_list. Entries are of type struct urom_cmd_desc.

Definition at line 135 of file doca_urom_plugin.h.

The documentation for this struct was generated from the following file:

include/doca_urom_plugin.h

Data Fields