Type Alias ucp_ep_params_t

pub type ucp_ep_params_t = ucp_ep_params;

@ingroup UCP_ENDPOINT @brief Tuning parameters for the UCP endpoint.

The structure defines the parameters that are used for the UCP endpoint tuning during the UCP ep @ref ucp_ep_create “creation”.

Aliased Type

struct ucp_ep_params_t {
    pub field_mask: u64,
    pub address: *const ucp_address,
    pub err_mode: ucp_err_handling_mode_t,
    pub err_handler: ucp_err_handler,
    pub user_data: *mut c_void,
    pub flags: u32,
    pub sockaddr: ucs_sock_addr,
    pub conn_request: *mut ucp_conn_request,
    pub name: *const i8,
}

Fields

field_mask: u64

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

address: *const ucp_address

Destination address; this field should be set along with its corresponding bit in the field_mask - @ref UCP_EP_PARAM_FIELD_REMOTE_ADDRESS and must be obtained using @ref ucp_worker_get_address.

err_mode: ucp_err_handling_mode_t

Desired error handling mode, optional parameter. Default value is @ref UCP_ERR_HANDLING_MODE_NONE.

err_handler: ucp_err_handler

Handler to process transport level failure.

user_data: *mut c_void

User data associated with an endpoint. See @ref ucp_stream_poll_ep_t and @ref ucp_err_handler_t

flags: u32

Endpoint flags from @ref ucp_ep_params_flags_field. This value is optional. If it’s not set (along with its corresponding bit in the field_mask - @ref UCP_EP_PARAM_FIELD_FLAGS), the @ref ucp_ep_create() routine will consider the flags as set to zero.

sockaddr: ucs_sock_addr

Destination address in the form of a sockaddr; this field should be set along with its corresponding bit in the field_mask - @ref UCP_EP_PARAM_FIELD_SOCK_ADDR and must be obtained from the user, it means that this type of the endpoint creation is possible only on client side in client-server connection establishment flow.

conn_request: *mut ucp_conn_request

Connection request from client; this field should be set along with its corresponding bit in the field_mask - @ref UCP_EP_PARAM_FIELD_CONN_REQUEST and must be obtained from @ref ucp_listener_conn_callback_t, it means that this type of the endpoint creation is possible only on server side in client-server connection establishment flow.

name: *const i8

Endpoint name. Tracing and analysis tools can identify the endpoint using this name. To retrieve the endpoint’s name, use @ref ucp_ep_query, as the name you supply may be changed by UCX under some circumstances, e.g. a name conflict. This field is only assigned if you set @ref UCP_EP_PARAM_FIELD_NAME in the field mask. If not, then a default unique name will be created for you.