Struct uct_iface_params

#[repr(C)]
pub struct uct_iface_params {

    pub field_mask: u64,
    pub cpu_mask: ucs_cpu_set_t,
    pub open_mode: u64,
    pub mode: uct_iface_params__bindgen_ty_1,
    pub stats_root: *mut ucs_stats_node_t,
    pub rx_headroom: size_t,
    pub err_handler_arg: *mut c_void,
    pub err_handler: uct_error_handler_t,
    pub err_handler_flags: u32,
    pub eager_arg: *mut c_void,
    pub eager_cb: uct_tag_unexp_eager_cb_t,
    pub rndv_arg: *mut c_void,
    pub rndv_cb: uct_tag_unexp_rndv_cb_t,
    pub async_event_arg: *mut c_void,
    pub async_event_cb: uct_async_event_cb_t,
    pub keepalive_interval: ucs_time_t,
    pub am_alignment: size_t,
    pub am_align_offset: size_t,
}

@ingroup UCT_RESOURCE @brief Parameters used for interface creation.

This structure should be allocated by the user and should be passed to @ref uct_iface_open. User has to initialize all fields of this structure.

Fields

field_mask: u64

Mask of valid fields in this structure, using bits from @ref uct_iface_params_field. Fields not specified in this mask will be ignored.

cpu_mask: ucs_cpu_set_t

Mask of CPUs to use for resources

open_mode: u64

Interface open mode bitmap. @ref uct_iface_open_mode

mode: uct_iface_params__bindgen_ty_1

stats_root: *mut ucs_stats_node_t

Root in the statistics tree. Can be NULL. If non NULL, it will be a root of @a uct_iface object in the statistics tree.

rx_headroom: size_t

How much bytes to reserve before the receive segment.

err_handler_arg: *mut c_void

Custom argument of @a err_handler.

err_handler: uct_error_handler_t

The callback to handle transport level error.

err_handler_flags: u32

Callback flags to indicate where the @a err_handler callback can be invoked from. @ref uct_cb_flags

eager_arg: *mut c_void

These callbacks are only relevant for HW Tag Matching

eager_cb: uct_tag_unexp_eager_cb_t

Callback for tag matching unexpected eager messages

rndv_arg: *mut c_void

rndv_cb: uct_tag_unexp_rndv_cb_t

Callback for tag matching unexpected rndv messages

async_event_arg: *mut c_void

async_event_cb: uct_async_event_cb_t

Callback for asynchronous event handling. The callback will be invoked from UCT transport when there are new events to be read by user if the iface has @ref UCT_IFACE_FLAG_EVENT_ASYNC_CB capability

keepalive_interval: ucs_time_t

am_alignment: size_t

Desired alignment for Active Messages on the receiver. Note that only data received in the UCT descriptor can be aligned (i.e. @a UCT_CB_PARAM_FLAG_DESC flag is provided in the Active Message handler callback). The provided value must be power of 2. The default value is 1.

am_align_offset: size_t

Offset in the Active Message receive buffer, which should be aligned to the @a am_alignment boundary. Note this parameter has no effect without setting @a am_alignment parameter. The provided value must be less than the given @a am_alignment value. The default value is 0.

+-+ pointer to @a data in @ref uct_am_callback_t | | + alignment boundary | | v v +—————––+ | align | | | offset | | +—————––+

Trait Implementations

impl Clone for uct_iface_params

fn clone(&self) -> uct_iface_params

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for uct_iface_params