Type Alias ucp_am_handler_param_t

pub type ucp_am_handler_param_t = ucp_am_handler_param;

@ingroup UCP_WORKER @brief Active Message handler parameters passed to @ref ucp_worker_set_am_recv_handler routine.

Aliased Type

struct ucp_am_handler_param_t {
    pub field_mask: u64,
    pub id: u32,
    pub flags: u32,
    pub cb: Option<unsafe extern "C" fn(_: *mut c_void, _: *const c_void, _: u32, _: *mut c_void, _: u32, _: *const ucp_am_recv_param) -> ucs_status_t>,
    pub arg: *mut c_void,
}

Fields

field_mask: u64

Mask of valid fields in this structure, using bits from @ref ucp_am_handler_param_field. Fields not specified in this mask will be ignored. Provides ABI compatibility with respect to adding new fields.

id: u32

Active Message id.

flags: u32

Handler flags as defined by @ref ucp_am_cb_flags.

cb: Option<unsafe extern "C" fn(_: *mut c_void, _: *const c_void, _: u32, _: *mut c_void, _: u32, _: *const ucp_am_recv_param) -> ucs_status_t>

Active Message callback. To clear the already set callback, this value should be set to NULL.

arg: *mut c_void

Active Message argument, which will be passed in to every invocation of @ref ucp_am_recv_callback_t function as the @a arg argument.