com.pcbsys.nirvana.nAdminAPI.nRDMAInterface Class Reference

RDMA Interface class. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nRDMAInterface:
com.pcbsys.nirvana.nAdminAPI.nInterface com.pcbsys.nirvana.nAdminAPI.nBaseInterface

Public Member Functions

int getBufferSize ()
 Gets the size of the shared memory buffers used. More...
 
int getTimeout ()
 Get the value for the RDMA read / write timeout. More...
 
 nRDMAInterface (String adapter, int port, boolean autostart) throws nAdminIllegalArgumentException
 Creates a RDMA configuration with the supplied timeout and autostart flag. More...
 
void setBufferSize (int size)
 Sets the size of the RDMA memory buffers used. More...
 
void setTimeout (int timeout)
 Set the timeout value used. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nInterface
boolean canAdvertise ()
 Will this interface be used by other realms to send client redirects to. More...
 
String getAdapaterAlias ()
 Returns the interfaces known alias's. More...
 
int getAuthTimeOut ()
 Returns the number of milliseconds that the remote client has to authenticate with the server before the server closes the communications with the client. More...
 
int getBacklog ()
 The number of socket connect requests that the Operating System will queue before sending a reject to the remote client. More...
 
String getProtocol ()
 Returns the protocol string used by this interface. More...
 
int getRecvBufferSize ()
 Return the socket buffer size in bytes used by this interface when receiving data. More...
 
int getSelectThreadSize ()
 Returns the number of select threads used by NIO. More...
 
int getSendBufferSize ()
 Return the socket buffer size in bytes used by this interface when sending data. More...
 
int getThreadCount ()
 Returns the current Thread Pool size that handles client socket connections. More...
 
nACL getViaList ()
 Retrieves the interfaces Via list. More...
 
boolean isAllowNIO ()
 Returns whether NIO is enabled on this interface. More...
 
boolean isClientConnectionsAllowed ()
 Returns whether this interface can be used by clients to connect. More...
 
boolean isInterRealmAllow ()
 Returns whether this interface is allowed to be used in inter realm / cluster communication. More...
 
void setAdapterAlias (String alias)
 Sets the interfaces alias. More...
 
void setAdvertise (boolean flag)
 Change the current advertise status for this interface. More...
 
void setAllowClientConnections (boolean clientconnections)
 Sets whether this interface can accept client connections or not. More...
 
void setAllowNIO (boolean allowNIO)
 Set whether NIO is enabled on the interface. More...
 
void setAuthTimeOut (int timeout) throws nAdminIllegalArgumentException
 Changes the number of milliseconds that the remote client has to authenticate with the server. More...
 
void setBacklog (int backlog) throws nAdminIllegalArgumentException
 Changes the number of connections to queue before the Operating System will send rejects to the remote client. More...
 
void setInterRealmAllow (boolean interealmAllow)
 Sets whether this interface is allowed to be used in inter realm / cluster communication. More...
 
void setManager (nInterfaceManager im)
 Set the Interface Manager. More...
 
void setRecvBufferSize (int myRecvBufferSize)
 Set the socket buffer size in bytes used by this interface when receiving data. More...
 
void setSelectThreadSize (int selectThreadSize)
 Sets the number of select threads used by NIO. More...
 
void setSendBufferSize (int mySendBufferSize)
 Set the socket buffer size in bytes used by this interface when sending data. More...
 
void setThreadCount (int count) throws nAdminIllegalArgumentException
 Changes the thread pool size handling the client connections. More...
 
void setViaList (nACL acl) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 Commits the nACL object passed in with the Realm Server. More...
 
String toString ()
 Return a string representation of the interface details. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nBaseInterface
String getAdapter ()
 Get the adapter that this interface will use. More...
 
String getName ()
 Get the name of this interface. More...
 
int getPort ()
 Get the port that this interface will bind to at startup. More...
 
String getURL ()
 Get the URL that specifies this interface. More...
 
void setAutostart (boolean flag)
 Change the current Autostart status for this interface. More...
 
boolean willAutostart ()
 Will this interface automatically be started when the Realm Server starts. More...
 

Detailed Description

RDMA Interface class.

This class exposes the current settings for an RDMA protocol adapter on the Nirvana Realm server. It is also used to construct a new interface on the Realm server, however, the name is only valid when the Realm server has added the interface.

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nRDMAInterface.nRDMAInterface ( String  adapter,
int  port,
boolean  autostart 
) throws nAdminIllegalArgumentException

Creates a RDMA configuration with the supplied timeout and autostart flag.

Exceptions
nAdminIllegalArgumentExceptionif adapter is null or the port range is invalid

Member Function Documentation

int com.pcbsys.nirvana.nAdminAPI.nRDMAInterface.getBufferSize ( )

Gets the size of the shared memory buffers used.

Returns
the size of the shared memory buffers
int com.pcbsys.nirvana.nAdminAPI.nRDMAInterface.getTimeout ( )

Get the value for the RDMA read / write timeout.

Returns
the timeout value
void com.pcbsys.nirvana.nAdminAPI.nRDMAInterface.setBufferSize ( int  size)

Sets the size of the RDMA memory buffers used.

Parameters
sizeof the shared memory buffer
void com.pcbsys.nirvana.nAdminAPI.nRDMAInterface.setTimeout ( int  timeout)

Set the timeout value used.

Parameters
timeoutvalue used for read / write timeouts