Function uct_ep_create

Source
pub unsafe extern "C" fn uct_ep_create(
    params: *const uct_ep_params_t,
    ep_p: *mut uct_ep_h,
) -> ucs_status_t
Expand description

@ingroup UCT_RESOURCE @brief Create new endpoint.

Create a UCT endpoint in one of the available modes: -# Unconnected endpoint: If no any address is present in @ref uct_ep_params, this creates an unconnected endpoint. To establish a connection to a remote endpoint, @ref uct_ep_connect_to_ep will need to be called. Use of this mode requires @ref uct_ep_params_t::iface has the @ref UCT_IFACE_FLAG_CONNECT_TO_EP capability flag. It may be obtained by @ref uct_iface_query . -# Connect to a remote interface: If @ref uct_ep_params_t::dev_addr and @ref uct_ep_params_t::iface_addr are set, this will establish an endpoint that is connected to a remote interface. This requires that @ref uct_ep_params_t::iface has the @ref UCT_IFACE_FLAG_CONNECT_TO_IFACE capability flag. It may be obtained by @ref uct_iface_query. -# Connect to a remote socket address: If @ref uct_ep_params_t::sockaddr is set, this will create an endpoint that is connected to a remote socket. This requires that either @ref uct_ep_params::cm, or @ref uct_ep_params::iface will be set. In the latter case, the interface has to support @ref UCT_IFACE_FLAG_CONNECT_TO_SOCKADDR flag, which can be checked by calling @ref uct_iface_query. @param [in] params User defined @ref uct_ep_params_t configuration for the @a ep_p. @param [out] ep_p Filled with handle to the new endpoint.

@return UCS_OK The endpoint is created successfully. This does not guarantee that the endpoint has been connected to the destination defined in @a params; in case of failure, the error will be reported to the interface error handler callback provided to @ref uct_iface_open via @ref uct_iface_params_t.err_handler. @return Error code as defined by @ref ucs_status_t