Type Alias ucp_worker_attr_t

pub type ucp_worker_attr_t = ucp_worker_attr;

@ingroup UCP_WORKER @brief UCP worker attributes.

The structure defines the attributes which characterize the particular worker.

Aliased Type

struct ucp_worker_attr_t {
    pub field_mask: u64,
    pub thread_mode: ucs_thread_mode_t,
    pub address_flags: u32,
    pub address: *mut ucp_address,
    pub address_length: u32,
    pub max_am_header: u32,
    pub name: [i8; 32],
    pub max_debug_string: u32,
}

Fields

field_mask: u64

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

thread_mode: ucs_thread_mode_t

Thread safe level of the worker.

address_flags: u32

Flags indicating requested details of the worker address. If @ref UCP_WORKER_ATTR_FIELD_ADDRESS_FLAGS bit is set in the field_mask, this value should be set as well. Possible flags are specified in @ref ucp_worker_address_flags_t. @note This is an input attribute.

address: *mut ucp_address

Worker address, which can be passed to remote instances of the UCP library in order to connect to this worker. The memory for the address handle is allocated by @ref ucp_worker_query “ucp_worker_query()” routine, and must be released by using @ref ucp_worker_release_address “ucp_worker_release_address()” routine.

address_length: u32

Size of worker address in bytes.

max_am_header: u32

Maximum allowed header size for @ref ucp_am_send_nbx routine.

name: [i8; 32]

Tracing and analysis tools can identify the worker using this name.

max_debug_string: u32

Maximum debug string size that can be filled with @ref ucp_request_query.