org.openucx.jucx.ucp

Class UcpAmData

java.lang.Object

org.openucx.jucx.ucp.UcpAmData

All Implemented Interfaces:

Closeable, AutoCloseable

public class UcpAmData
extends Object
implements Closeable

Wrapper over received active message data. Could be one of: - Internal ucx data descriptor. Need to call receive(long, org.openucx.jucx.UcxCallback) to receive actual data. - Actual data. Need to call close() when not needed.

Method Summary

Modifier and Type	Method and Description
boolean	canPersist() Whether this amData descriptor can be persisted outside UcpAmRecvCallback.onReceive(long, long, org.openucx.jucx.ucp.UcpAmData, org.openucx.jucx.ucp.UcpEndpoint) callback by returning UcsConstants.STATUS#UCS_INPROGRESS
void	close()
long	getDataAddress() Get an address of received data
long	getDataHandle() Get UCX data handle descriptor to pass to UcpWorker.recvAmDataNonBlocking(long, long, long, org.openucx.jucx.UcxCallback, org.openucx.jucx.ucp.UcpRequestParams)
long	getFlags() Receive operation flags.
long	getLength()
boolean	isDataValid() Whether actual data is received or need to call receive(long, UcxCallback)
UcpRequest	receive(long resultAddress, UcxCallback callback)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isDataValid

public boolean isDataValid()

Whether actual data is received or need to call receive(long, UcxCallback)

canPersist

public boolean canPersist()

Whether this amData descriptor can be persisted outside UcpAmRecvCallback.onReceive(long, long, org.openucx.jucx.ucp.UcpAmData, org.openucx.jucx.ucp.UcpEndpoint) callback by returning UcsConstants.STATUS#UCS_INPROGRESS

getFlags

public long getFlags()

Receive operation flags.

getDataAddress

public long getDataAddress()

Get an address of received data

getLength

public long getLength()

getDataHandle

public long getDataHandle()

Get UCX data handle descriptor to pass to UcpWorker.recvAmDataNonBlocking(long, long, long, org.openucx.jucx.UcxCallback, org.openucx.jucx.ucp.UcpRequestParams)

receive

public UcpRequest receive(long resultAddress,
                          UcxCallback callback)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException