org.openucx.jucx.ucp

Class UcpConstants

java.lang.Object

org.openucx.jucx.ucp.UcpConstants

public class UcpConstants
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static long	UCP_AM_FLAG_PERSISTENT_DATA Guarantees that the specified UcpAmRecvCallback.onReceive(long, long, org.openucx.jucx.ucp.UcpAmData, org.openucx.jucx.ucp.UcpEndpoint) callback, will always be called with UCP_AM_RECV_ATTR_FLAG_DATA flag set, and UcpAmData.canPersist() will return true, so the data will be accessible outside the callback, until UcpWorker.amDataRelease(long) is called.
static long	UCP_AM_FLAG_WHOLE_MSG Indicates that the entire message will be handled in one callback.
static long	UCP_AM_RECV_ATTR_FLAG_DATA Indicates that the data provided in UcpAmRecvCallback callback can be held by the user.
static long	UCP_AM_RECV_ATTR_FLAG_RNDV Indicates that the arriving data was sent using rendezvous protocol.
static long	UCP_AM_SEND_FLAG_EAGER
static long	UCP_AM_SEND_FLAG_REPLY Flags dictate the behavior of UcpEndpoint.sendAmNonBlocking(int, long, long, long, long, long, org.openucx.jucx.UcxCallback, int) routine.
static long	UCP_AM_SEND_FLAG_RNDV
static long	UCP_MEM_MAP_PROT_LOCAL_READ The enumeration list describes the memory mapping protections supported by UcpContext.memoryMap(UcpMemMapParams)
static long	UCP_MEM_MAP_PROT_LOCAL_WRITE
static long	UCP_MEM_MAP_PROT_REMOTE_READ
static long	UCP_MEM_MAP_PROT_REMOTE_WRITE
static long	UCP_STREAM_RECV_FLAG_WAITALL The enumeration defines behavior of UcpEndpoint.recvStreamNonBlocking(long, long, long, UcxCallback) function.

Constructor Summary

Constructors

Constructor and Description
UcpConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

UCP_MEM_MAP_PROT_LOCAL_READ

public static long UCP_MEM_MAP_PROT_LOCAL_READ

The enumeration list describes the memory mapping protections supported by UcpContext.memoryMap(UcpMemMapParams)

UCP_MEM_MAP_PROT_LOCAL_WRITE

public static long UCP_MEM_MAP_PROT_LOCAL_WRITE

UCP_MEM_MAP_PROT_REMOTE_READ

public static long UCP_MEM_MAP_PROT_REMOTE_READ

UCP_MEM_MAP_PROT_REMOTE_WRITE

public static long UCP_MEM_MAP_PROT_REMOTE_WRITE

UCP_STREAM_RECV_FLAG_WAITALL

public static long UCP_STREAM_RECV_FLAG_WAITALL

The enumeration defines behavior of UcpEndpoint.recvStreamNonBlocking(long, long, long, UcxCallback) function.

UCP_AM_RECV_ATTR_FLAG_DATA

public static long UCP_AM_RECV_ATTR_FLAG_DATA

Indicates that the data provided in UcpAmRecvCallback callback can be held by the user. If UcsConstants.STATUS.UCS_INPROGRESS is returned from the callback, the data parameter will persist and the user has to call UcpWorker.amDataRelease(long) when data is no longer needed. This flag is mutually exclusive with UCP_AM_RECV_ATTR_FLAG_RNDV.

UCP_AM_RECV_ATTR_FLAG_RNDV

public static long UCP_AM_RECV_ATTR_FLAG_RNDV

Indicates that the arriving data was sent using rendezvous protocol. In this case dataAddress parameter of the UcpAmRecvCallback.onReceive(long, long, org.openucx.jucx.ucp.UcpAmData, org.openucx.jucx.ucp.UcpEndpoint) points to the internal UCP descriptor, which can be used for obtaining the actual data by calling UcpWorker.recvAmDataNonBlocking(long, long, long, org.openucx.jucx.UcxCallback, int) routine. This flag is mutually exclusive with UCP_AM_RECV_ATTR_FLAG_DATA.

UCP_AM_SEND_FLAG_REPLY

public static long UCP_AM_SEND_FLAG_REPLY

Flags dictate the behavior of UcpEndpoint.sendAmNonBlocking(int, long, long, long, long, long, org.openucx.jucx.UcxCallback, int) routine.

UCP_AM_SEND_FLAG_EAGER

public static long UCP_AM_SEND_FLAG_EAGER

UCP_AM_SEND_FLAG_RNDV

public static long UCP_AM_SEND_FLAG_RNDV

UCP_AM_FLAG_WHOLE_MSG

public static long UCP_AM_FLAG_WHOLE_MSG

Indicates that the entire message will be handled in one callback. With this option, message ordering is not guaranteed (i.e. receive callbacks may be invoked in a different order than messages were sent). If this flag is not set, the data callback may be invoked several times for the same message (if, for example, it was split into several fragments by the transport layer). It is guaranteed that the first data callback for a particular message is invoked for the first fragment. The ordering of first message fragments is guaranteed (i.e. receive callbacks will be called in the order the messages were sent). The order of other fragments is not guaranteed. User header is passed with the first fragment only.

UCP_AM_FLAG_PERSISTENT_DATA

public static long UCP_AM_FLAG_PERSISTENT_DATA

Guarantees that the specified UcpAmRecvCallback.onReceive(long, long, org.openucx.jucx.ucp.UcpAmData, org.openucx.jucx.ucp.UcpEndpoint) callback, will always be called with UCP_AM_RECV_ATTR_FLAG_DATA flag set, and UcpAmData.canPersist() will return true, so the data will be accessible outside the callback, until UcpWorker.amDataRelease(long) is called.

Constructor Detail

UcpConstants

public UcpConstants()