org.openucx.jucx.ucp

Class UcpContext

java.lang.Object

org.openucx.jucx.UcxNativeStruct

org.openucx.jucx.ucp.UcpContext

All Implemented Interfaces:

Closeable, AutoCloseable

public class UcpContext
extends UcxNativeStruct
implements Closeable

UCP application context (or just a context) is an opaque handle that holds a UCP communication instance's global information. It represents a single UCP communication instance. The communication instance could be an OS process (an application) that uses UCP library. This global information includes communication resources, endpoints, memory, temporary file storage, and other communication information directly associated with a specific UCP instance. The context also acts as an isolation mechanism, allowing resources associated with the context to manage multiple concurrent communication instances. For example, users can isolate their communication by allocating and using separate contexts. Alternatively, users can share the communication resources (memory, network resource context, etc.) between them by using the same application context. A message sent or a RMA operation performed in one application context cannot be received in any other application context.

Constructor Summary

Constructors

Constructor and Description
UcpContext(UcpParams params)

Method Summary

Modifier and Type	Method and Description
void	close()
long	getMemoryTypesMask()
UcpMemory	memoryMap(UcpMemMapParams params) Associates memory allocated/mapped region with communication operations.
UcpWorker	newWorker(UcpWorkerParams params) Creates new UcpWorker on current context.
UcpMemory	registerMemory(ByteBuffer buf) Associates memory allocated/mapped region with communication operations.

Methods inherited from class org.openucx.jucx.UcxNativeStruct

equals, getNativeId, hashCode, setNativeId

Methods inherited from class java.lang.Object

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

Constructor Detail

UcpContext

public UcpContext(UcpParams params)

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getMemoryTypesMask

public long getMemoryTypesMask()

Returns:

- mask which memory types are supported, for supported memory types please see UcsConstants.MEMORY_TYPE.isMemTypeSupported(long, int)

newWorker

public UcpWorker newWorker(UcpWorkerParams params)

Creates new UcpWorker on current context.

registerMemory

public UcpMemory registerMemory(ByteBuffer buf)

Associates memory allocated/mapped region with communication operations. The network stack associated with an application context can typically send and receive data from the mapped memory without CPU intervention; some devices and associated network stacks require the memory to be registered to send and receive data.

memoryMap

public UcpMemory memoryMap(UcpMemMapParams params)

Associates memory allocated/mapped region with communication operations. The network stack associated with an application context can typically send and receive data from the mapped memory without CPU intervention; some devices and associated network stacks require the memory to be registered to send and receive data.