org.openucx.jucx.ucp

Class UcpWorkerParams

java.lang.Object

org.openucx.jucx.UcxParams

org.openucx.jucx.ucp.UcpWorkerParams

public class UcpWorkerParams
extends UcxParams

Field Summary

Fields inherited from class org.openucx.jucx.UcxParams

fieldMask

Constructor Summary

Constructors

Constructor and Description
UcpWorkerParams()

Method Summary

Modifier and Type	Method and Description
UcpWorkerParams	clear() Reset state of parameters.
UcpWorkerParams	requestThreadSafety() Requests the thread safety mode which worker and the associated resources should be created with.
UcpWorkerParams	requestWakeupAMO() Atomic operation send completion.
UcpWorkerParams	requestWakeupEdge() Use edge-triggered wakeup.
UcpWorkerParams	requestWakeupRMA() Remote memory access send completion.
UcpWorkerParams	requestWakeupRX() This event type will generate an event on completion of any receive operation (complete or partial, according to the underlying protocol).
UcpWorkerParams	requestWakeupTagRecv() Tag receive completion.
UcpWorkerParams	requestWakeupTagSend() Tag send completion.
UcpWorkerParams	requestWakeupTX() This event type will generate an event on completion of any outgoing operation (complete or partial, according to the underlying protocol) for any type of transfer (send, atomic, or RMA).
UcpWorkerParams	setClientId(long clientId) User defined client id when connecting to remote socket address.
UcpWorkerParams	setCpu(int cpuNum) Mask of which CPUs worker resources should preferably be allocated on.
UcpWorkerParams	setEventFD(int eventFD) External event file descriptor.
UcpWorkerParams	setUserData(ByteBuffer userData) User data associated with the current worker.

Methods inherited from class org.openucx.jucx.UcxParams

checkArraySizes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UcpWorkerParams

public UcpWorkerParams()

Method Detail

clear

public UcpWorkerParams clear()

Description copied from class: UcxParams

Reset state of parameters.

Overrides:

clear in class UcxParams

requestThreadSafety

public UcpWorkerParams requestThreadSafety()

Requests the thread safety mode which worker and the associated resources should be created with. When thread safety requested, the UcpWorker.UcpWorker(UcpContext, UcpWorkerParams) attempts to create worker where multiple threads can access concurrently. The thread mode with which worker is created can differ from the suggested mode.

setCpu

public UcpWorkerParams setCpu(int cpuNum)

Mask of which CPUs worker resources should preferably be allocated on. This value is optional. If it's not set, resources are allocated according to system's default policy.

requestWakeupRMA

public UcpWorkerParams requestWakeupRMA()

Remote memory access send completion.

requestWakeupAMO

public UcpWorkerParams requestWakeupAMO()

Atomic operation send completion.

requestWakeupTagSend

public UcpWorkerParams requestWakeupTagSend()

Tag send completion.

requestWakeupTagRecv

public UcpWorkerParams requestWakeupTagRecv()

Tag receive completion.

requestWakeupTX

public UcpWorkerParams requestWakeupTX()

This event type will generate an event on completion of any outgoing operation (complete or partial, according to the underlying protocol) for any type of transfer (send, atomic, or RMA).

requestWakeupRX

public UcpWorkerParams requestWakeupRX()

This event type will generate an event on completion of any receive operation (complete or partial, according to the underlying protocol).

requestWakeupEdge

public UcpWorkerParams requestWakeupEdge()

Use edge-triggered wakeup. The event file descriptor will be signaled only for new events, rather than existing ones.

setUserData

public UcpWorkerParams setUserData(ByteBuffer userData)

User data associated with the current worker.

setEventFD

public UcpWorkerParams setEventFD(int eventFD)

External event file descriptor.

Events on the worker will be reported on the provided event file descriptor. The provided file descriptor must be capable of aggregating notifications for arbitrary events, for example epoll(7) on Linux systems.

userData will be used as the event user-data on systems which support it. For example, on Linux, it will be placed in epoll_data_t::ptr, when returned from epoll_wait(2).

Otherwise, events would be reported to the event file descriptor returned from ucp_worker_get_efd().

setClientId

public UcpWorkerParams setClientId(long clientId)

User defined client id when connecting to remote socket address. This value is available via UcpConnectionRequest.getClientId() function on the server side.