org.openucx.jucx.ucp

Class UcpEndpointParams

java.lang.Object

org.openucx.jucx.UcxParams

org.openucx.jucx.ucp.UcpEndpointParams

public class UcpEndpointParams
extends UcxParams

Tuning parameters for the UCP endpoint.

Field Summary

Fields inherited from class org.openucx.jucx.UcxParams

fieldMask

Constructor Summary

Constructors

Constructor and Description
UcpEndpointParams()

Method Summary

Modifier and Type	Method and Description
UcpEndpointParams	clear() Reset state of parameters.
UcpEndpointParams	sendClientId() Send worker's client id when connecting to remote socket address as part of the connection request payload.
UcpEndpointParams	setConnectionRequest(UcpConnectionRequest connectionRequest) Connection request from client.
UcpEndpointParams	setErrorHandler(UcpEndpointErrorHandler errorHandler) Handler to process transport level failure.
UcpEndpointParams	setName(String name) Endpoint name.
UcpEndpointParams	setNoLoopbackMode() Avoid connecting the endpoint to itself when connecting the endpoint to the same worker it was created on.
UcpEndpointParams	setPeerErrorHandlingMode() Guarantees that send requests are always completed (successfully or error) even in case of remote failure, disables protocols and APIs which may cause a hang or undefined behavior in case of peer failure, may affect performance and memory footprint.
UcpEndpointParams	setSocketAddress(InetSocketAddress socketAddress) Destination address in form of InetSocketAddress.
UcpEndpointParams	setUcpAddress(ByteBuffer ucpAddress) Destination address in form of workerAddress.
String	toString()

Methods inherited from class org.openucx.jucx.UcxParams

checkArraySizes

Methods inherited from class java.lang.Object

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

Constructor Detail

UcpEndpointParams

public UcpEndpointParams()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

clear

public UcpEndpointParams clear()

Description copied from class: UcxParams

Reset state of parameters.

Overrides:

clear in class UcxParams

setUcpAddress

public UcpEndpointParams setUcpAddress(ByteBuffer ucpAddress)

Destination address in form of workerAddress.

setPeerErrorHandlingMode

public UcpEndpointParams setPeerErrorHandlingMode()

Guarantees that send requests are always completed (successfully or error) even in case of remote failure, disables protocols and APIs which may cause a hang or undefined behavior in case of peer failure, may affect performance and memory footprint.

setSocketAddress

public UcpEndpointParams setSocketAddress(InetSocketAddress socketAddress)

Destination address in form of InetSocketAddress.

setNoLoopbackMode

public UcpEndpointParams setNoLoopbackMode()

Avoid connecting the endpoint to itself when connecting the endpoint to the same worker it was created on. Affects protocols which send to a particular remote endpoint, for example stream.

setConnectionRequest

public UcpEndpointParams setConnectionRequest(UcpConnectionRequest connectionRequest)

Connection request from client.

setErrorHandler

public UcpEndpointParams setErrorHandler(UcpEndpointErrorHandler errorHandler)

Handler to process transport level failure.

setName

public UcpEndpointParams setName(String name)

Endpoint name. Tracing and analysis tools can identify the endpoint using this name. Name you supply may be changed by UCX under some circumstances, e.g. a name conflict.

sendClientId

public UcpEndpointParams sendClientId()

Send worker's client id when connecting to remote socket address as part of the connection request payload. On the remote side client id can be obtained from UcpConnectionRequest.getClientId()