- com
- pcbsys
- nirvana
- nAdminAPI
- nInterface
Abstract Class nInterface. More...
Public Member Functions | |
| 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... | |
Abstract Class nInterface.
This class exposes the common attributes to all Nirvana Realm interfaces.
| boolean com.pcbsys.nirvana.nAdminAPI.nInterface.canAdvertise | ( | ) |
Will this interface be used by other realms to send client redirects to.
| String com.pcbsys.nirvana.nAdminAPI.nInterface.getAdapaterAlias | ( | ) |
Returns the interfaces known alias's.
This is used by the server to tell other servers how to contact it if it is behind a NAT or Proxy server. It is specified as a HOST:PORT syntax
| int com.pcbsys.nirvana.nAdminAPI.nInterface.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.
| int com.pcbsys.nirvana.nAdminAPI.nInterface.getBacklog | ( | ) |
The number of socket connect requests that the Operating System will queue before sending a reject to the remote client.
| String com.pcbsys.nirvana.nAdminAPI.nInterface.getProtocol | ( | ) |
Returns the protocol string used by this interface.
Can be one of nsp, nsps, nhps or nhp
| int com.pcbsys.nirvana.nAdminAPI.nInterface.getRecvBufferSize | ( | ) |
Return the socket buffer size in bytes used by this interface when receiving data.
| int com.pcbsys.nirvana.nAdminAPI.nInterface.getSelectThreadSize | ( | ) |
Returns the number of select threads used by NIO.
| int com.pcbsys.nirvana.nAdminAPI.nInterface.getSendBufferSize | ( | ) |
Return the socket buffer size in bytes used by this interface when sending data.
| int com.pcbsys.nirvana.nAdminAPI.nInterface.getThreadCount | ( | ) |
Returns the current Thread Pool size that handles client socket connections.
Depending on the number of connections/second this size should be around 1 or 2 anything more may not really gain any improvement
| nACL com.pcbsys.nirvana.nAdminAPI.nInterface.getViaList | ( | ) |
| boolean com.pcbsys.nirvana.nAdminAPI.nInterface.isAllowNIO | ( | ) |
Returns whether NIO is enabled on this interface.
| boolean com.pcbsys.nirvana.nAdminAPI.nInterface.isClientConnectionsAllowed | ( | ) |
Returns whether this interface can be used by clients to connect.
| boolean com.pcbsys.nirvana.nAdminAPI.nInterface.isInterRealmAllow | ( | ) |
Returns whether this interface is allowed to be used in inter realm / cluster communication.
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setAdapterAlias | ( | String | alias | ) |
Sets the interfaces alias.
This string is of the format HOST:PORT where HOST is the alias interface and port is the number used to communicate with the server.
| alias | an alias hostname for the interface |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setAdvertise | ( | boolean | flag | ) |
Change the current advertise status for this interface.
| flag | True or False |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setAllowClientConnections | ( | boolean | clientconnections | ) |
Sets whether this interface can accept client connections or not.
| clientconnections | whether this interface can be used by clients |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setAllowNIO | ( | boolean | allowNIO | ) |
Set whether NIO is enabled on the interface.
| allowNIO | whether NIO is enabled |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setAuthTimeOut | ( | int | timeout | ) | throws nAdminIllegalArgumentException |
Changes the number of milliseconds that the remote client has to authenticate with the server.
| timeout | time in milliseconds |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setBacklog | ( | int | backlog | ) | throws nAdminIllegalArgumentException |
Changes the number of connections to queue before the Operating System will send rejects to the remote client.
| backlog | Must be between 1 and 1000 |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setInterRealmAllow | ( | boolean | interealmAllow | ) |
Sets whether this interface is allowed to be used in inter realm / cluster communication.
| interealmAllow | whether this interface is allowed for cluster commincation |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setManager | ( | nInterfaceManager | im | ) |
Set the Interface Manager.
| im | the interface manager to use |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setRecvBufferSize | ( | int | myRecvBufferSize | ) |
Set the socket buffer size in bytes used by this interface when receiving data.
| myRecvBufferSize | the inbound socket buffer size in bytes used by this interface |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setSelectThreadSize | ( | int | selectThreadSize | ) |
Sets the number of select threads used by NIO.
| selectThreadSize | the number of select threads used |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setSendBufferSize | ( | int | mySendBufferSize | ) |
Set the socket buffer size in bytes used by this interface when sending data.
| mySendBufferSize | the size to set the outbound buffer size to |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setThreadCount | ( | int | count | ) | throws nAdminIllegalArgumentException |
Changes the thread pool size handling the client connections.
| count | Must be between 1 and 1024 inclusive |
| void com.pcbsys.nirvana.nAdminAPI.nInterface.setViaList | ( | nACL | acl | ) | throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException |
Commits the nACL object passed in with the Realm Server.
This causes these nInterfaceViaEntry to be active once the function returns. The nACL object can be retrieved by calling the getViaList() function which returns the interface current VIA list.
| acl | A nACL containing nInterfaceViaEntry |
| nInsufficientPrivilegesException | If the user is not permissioned to perform this operation |
| nNodeException | if the ACLs being set are invalid |
| nBaseAdminException | if unable to perform the operation, check the message for further information |
| String com.pcbsys.nirvana.nAdminAPI.nInterface.toString | ( | ) |
Return a string representation of the interface details.