com.pcbsys.nirvana.nAdminAPI.nSocketInterface Class Reference

Socket Interface class. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nSocketInterface:
com.pcbsys.nirvana.nAdminAPI.nInterface com.pcbsys.nirvana.nAdminAPI.nBaseInterface com.pcbsys.nirvana.nAdminAPI.nSSLInterface

Public Member Functions

 nSocketInterface (string adapter, int port)
 Creates a new Socket Interface with the supplied values More...
 
 nSocketInterface (string adapter, int port, bool autostart)
 Creates a new Socket Interface with the supplied values More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nInterface
virtual bool canAdvertise ()
 Will this interface be used by other realms to send client redirects to. More...
 
bool Equals (long aLong)
 used to sort interfaces
 
override bool Equals (object item)
 used to sort interfaces
 
virtual string getAdapaterAlias ()
 Returns the interfaces known alias's. More...
 
virtual string getAdapter ()
 Get the adapter that this interface will use. More...
 
virtual 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...
 
virtual int getBacklog ()
 The number of socket connect requests that the Operating System will queue before sending a reject to the remote client. More...
 
virtual int getPort ()
 Get the port that this interface will bind to at startup More...
 
virtual string getProtocol ()
 Returns the protocol string used by this interface. More...
 
virtual int getRecvBufferSize ()
 Return the socket buffer size in bytes used by this interface when receiving data More...
 
virtual int getSelectThreadSize ()
 Returns the number of select threads used by NIO More...
 
virtual int getSendBufferSize ()
 Return the socket buffer size in bytes used by this interface when sending data More...
 
virtual int getThreadCount ()
 Returns the current Thread Pool size that handles client socket connections. More...
 
virtual string getURL ()
 Get the URL that specifies this interface. More...
 
virtual nACL getViaList ()
 Retrieves the interfaces Via list. More...
 
virtual bool isAllowNIO ()
 Returns whether NIO is enabled on this interface More...
 
virtual bool isClientConnectionsAllowed ()
 Returns whether this interface can be used by clients to connect More...
 
virtual bool isInterRealmAllow ()
 Returns whether this interface is allowed to be used in inter realm / cluster communication More...
 
virtual bool lessThan (long aLong)
 used to sort interfaces
 
virtual bool lessThan (object item)
 used to sort interfaces
 
virtual void setAdapterAlias (string alias)
 Sets the interfaces alias. More...
 
virtual void setAdvertise (bool flag)
 Change the current advertise status for this interface More...
 
virtual void setAllowClientConnections (bool clientconnections)
 Sets whether this interface can accept client connections or not More...
 
virtual void setAllowNIO (bool allowNIO)
 Set whether NIO is enabled on the interface More...
 
virtual void setAuthTimeOut (int timeout)
 Changes the number of milliseconds that the remote client has to authenticate with the server. More...
 
virtual void setAutostart (bool flag)
 Change the current Autostart status for this interface More...
 
virtual void setBacklog (int backlog)
 Changes the number of connections to queue before the Operating System will send rejects to the remote client More...
 
virtual void setInterRealmAllow (bool interealmAllow)
 Sets whether this interface is allowed to be used in inter realm / cluster communication More...
 
virtual void setManager (nInterfaceManager im)
 Sets the interface manager More...
 
virtual void setRecvBufferSize (int myRecvBufferSize)
 Set the socket buffer size in bytes used by this interface when receiving data More...
 
virtual void setSelectThreadSize (int selectThreadSize)
 Sets the number of select threads used by NIO More...
 
virtual void setSendBufferSize (int mySendBufferSize)
 Set the socket buffer size in bytes used by this interface when sending data More...
 
virtual void setThreadCount (int count)
 Changes the thread pool size handling the client connections More...
 
virtual void setUseForProxyForward (bool useForproxyForward)
 Set whether or not to use proxy forwarding More...
 
virtual void setViaList (nACL acl)
 Commits the nACL object passed in with the Realm Server. More...
 
override string ToString ()
 Return a string representation of the interface details More...
 
virtual bool useForProxyForward ()
 Indicates whether or not to use proxy forwarding More...
 
virtual bool willAutostart ()
 Will this interface automatically be started when the Realm Server starts More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nBaseInterface
int getPort ()
 Get the port that this interface will bind to at startup More...
 
String getURL ()
 Get the URL that specifies this interface. It is made up from the protocol the adapter and port More...
 
void setAutostart (bool flag)
 Change the current Autostart status for this interface More...
 
bool willAutostart ()
 Will this interface automatically be started when the Realm Server starts More...
 

Detailed Description

Socket Interface class.

This class exposes the current settings for a nsp 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.nSocketInterface.nSocketInterface ( string  adapter,
int  port 
)

Creates a new Socket Interface with the supplied values

Parameters
adapterThe adapter to bind to
portThe port to bind to
Exceptions
nAdminIllegalArgumentExceptionif the adapter is null or the port is in an invalid range
com.pcbsys.nirvana.nAdminAPI.nSocketInterface.nSocketInterface ( string  adapter,
int  port,
bool  autostart 
)

Creates a new Socket Interface with the supplied values

Parameters
adapterThe adapter to bind to
portThe port to bind to
autostartSpecifies whether to autostart this interface