Function ucp_worker_create

Source
pub unsafe extern "C" fn ucp_worker_create(
    context: ucp_context_h,
    params: *const ucp_worker_params_t,
    worker_p: *mut ucp_worker_h,
) -> ucs_status_t
Expand description

@ingroup UCP_WORKER @brief Create a worker object.

This routine allocates and initializes a @ref ucp_worker_h “worker” object. Each worker is associated with one and only one @ref ucp_context_h “application” context. In the same time, an application context can create multiple @ref ucp_worker_h “workers” in order to enable concurrent access to communication resources. For example, application can allocate a dedicated worker for each application thread, where every worker can be progressed independently of others.

@note The worker object is allocated within context of the calling thread

@param [in] context Handle to @ref ucp_context_h “UCP application context”. @param [in] params User defined @ref ucp_worker_params_t configurations for the @ref ucp_worker_h “UCP worker”. @param [out] worker_p A pointer to the worker object allocated by the UCP library

@return Error code as defined by @ref ucs_status_t