Type Alias ucp_am_callback_t

pub type ucp_am_callback_t = Option<unsafe extern "C" fn(arg: *mut c_void, data: *mut c_void, length: size_t, reply_ep: ucp_ep_h, flags: c_uint) -> ucs_status_t>;

@ingroup UCP_ENDPOINT @brief Callback to process incoming Active Message.

When the callback is called, @a flags indicates how @a data should be handled.

@param [in] arg User-defined argument. @param [in] data Points to the received data. This data may persist after the callback returns and needs to be freed with @ref ucp_am_data_release. @param [in] length Length of data. @param [in] reply_ep If the Active Message is sent with the UCP_AM_SEND_REPLY flag, the sending ep will be passed in. If not, NULL will be passed. @param [in] flags If this flag is set to UCP_CB_PARAM_FLAG_DATA, the callback can return UCS_INPROGRESS and data will persist after the callback returns.

@return UCS_OK @a data will not persist after the callback returns.

@return UCS_INPROGRESS Can only be returned if flags is set to UCP_CB_PARAM_FLAG_DATA. If UCP_INPROGRESS is returned, data will persist after the callback has returned. To free the memory, a pointer to the data must be passed into @ref ucp_am_data_release.

@note This callback should be set and released by @ref ucp_worker_set_am_handler function.

Aliased Type

enum ucp_am_callback_t {
    None,
    Some(unsafe extern "C" fn(_: *mut c_void, _: *mut c_void, _: u32, _: *mut ucp_ep, _: u32) -> ucs_status_t),
}

Variants

None

No value.

Some(unsafe extern "C" fn(_: *mut c_void, _: *mut c_void, _: u32, _: *mut ucp_ep, _: u32) -> ucs_status_t)

Some value of type T.