com.ibm.net.rdma.jverbs.cm

Class ConnectionParameter

java.lang.Object

com.ibm.net.rdma.jverbs.cm.ConnectionParameter

public class ConnectionParameter
extends java.lang.Object

Holder for RDMA connection properties. Used when establishing an RDMA connection during accept and connect.

Currently supports following connection properties:

• responderResources - The maximum number of outstanding RDMA read that the local side will accept from the remote side. This value must be less than or equal to the local RDMA DeviceAttribute maxQpRdAtom and remote RDMA DeviceAttribute maxQpInitRdAtom
  
  
• initiatorDepth - The maximum number of outstanding RDMA read that the local side will have to the remote side. This value must be less than or equal to the local RDMA DeviceAttribute maxQpInitRdAtom and remote RDMA DeviceAttribute maxQpRdAtom. The remote end can adjust this value when accepting the connection. Applies only to RDMA_PS_TCP.
  
  
• retryCount - The maximum number of times that a data transfer operation should be retried on the Connection when an error occurs. This setting controls the number of times to retry send and RDMA read/write operations when timeouts occur.
  
  
• rnrRetryCount - The maximum number of times that a send operation from the remote peer should be retried on a connection after receiving a receiver not ready (RNR) error. RNR errors are generated when a send request arrives before a buffer has been posted to receive the incoming data. Applies only to RDMA_PS_TCP.
  
  

Referred from RDMA programming manual by mellanox.

Constructor Summary

Constructors

Constructor and Description
ConnectionParameter() Returns an instance of connection parameter with default value.
ConnectionParameter(int responderResources, int initiatorDepth, int retryCount, int rnrRetryCount) Returns an instance of connection parameters holder with supplied values for initiatorDepth, responderResources, retryCount and rnrRetryCount.

Method Summary

Modifier and Type	Method and Description
int	getInitiatorDepth() Gets the initiator depth.
int	getResponderResources() Gets the responder resources.
int	getRetryCount() The number of times a data operation will be re-tried.
int	getRnrRetryCount() Gets the Receiver Not Ready (RNR) retry count.
void	setInitiatorDepth(int initiatorDepth) Sets the initiator depth.
void	setResponderResources(int responderResources) Sets the responder resources.
void	setRetryCount(int retryCount) Sets the retry count.
void	setRnrRetryCount(int rnrRetryCount) Sets the Receiver Not Ready (RNR) retry count.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionParameter

public ConnectionParameter()

Returns an instance of connection parameter with default value. Default as local DeviceAttribute maxQpRdAtom for both initiatorDepth and responderResources. 7 for both retryCount and rnrRetryCount.

ConnectionParameter

public ConnectionParameter(int responderResources,
                           int initiatorDepth,
                           int retryCount,
                           int rnrRetryCount)

Returns an instance of connection parameters holder with supplied values for initiatorDepth, responderResources, retryCount and rnrRetryCount. User value will default to local device limit for both initiatorDepth and responderResources, if the value fall out of range. Same for retryCount and rnrRetryCount, it defaults to 7, if the value falls out of range.

Method Detail

getInitiatorDepth

public int getInitiatorDepth()

Gets the initiator depth.

Returns:

the initiator depth.

getResponderResources

public int getResponderResources()

Gets the responder resources.

Returns:

the responder resources.

getRetryCount

public int getRetryCount()

The number of times a data operation will be re-tried.

Returns:

the retry count.

getRnrRetryCount

public int getRnrRetryCount()

Gets the Receiver Not Ready (RNR) retry count.

Returns:

the rnr retry count.

setInitiatorDepth

public void setInitiatorDepth(int initiatorDepth)

Sets the initiator depth. Default as local DeviceAttribute maxQpRdAtom for initiatorDepth, if user passed value falls out of range (ie) less than 1 or greater than max.

Parameters:

initiatorDepth - the new initiator depth.

setResponderResources

public void setResponderResources(int responderResources)

Sets the responder resources. Default as local DeviceAttribute maxQpRdAtom for responderResources, lif user passed value falls out of range (ie) less than 1 or greater than max.

Parameters:

responderResources - the new responder resources.

setRetryCount

public void setRetryCount(int retryCount)

Sets the retry count. Defaults to 7 if user passes negative or more than 7.

Parameters:

retryCount - the new retry count.

setRnrRetryCount

public void setRnrRetryCount(int rnrRetryCount)

Sets the Receiver Not Ready (RNR) retry count. Defaults to 7 if user passes negative or more than 7.

Parameters:

rnrRetryCount - the new rnr retry count