- com
- pcbsys
- nirvana
- nAdminAPI
- nInterface
Abstract Class nInterface. More...
#include <nInterface.h>
Public Member Functions | |
| bool | canAdvertise () |
| Will this interface be used by other realms to send client redirects to. More... | |
| virtual bool | Equals (const std::string &item) |
| Compares the name of this interface with the string parameter. More... | |
| virtual bool | Equals (nInterface *pItem) |
| Compares this nInterface object with another object. More... | |
| virtual const std::string & | getAdapaterAlias () |
| Returns the interfaces known alias's. More... | |
| virtual const std::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 const std::string & | getName () |
| Get the name of this interface. More... | |
| virtual int | getPort () |
| Get the port that this interface will bind to at startup. More... | |
| virtual const std::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 std::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... | |
| nInterface (fDriverConfig *pCfg, nInterfaceManager *pIm) | |
| Creates a new nInterface object from the supplied fDriverConfig and nInterfaceManager. More... | |
| virtual void | setAdapterAlias (const std::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 *pIm) |
| Set the Interface Manager. More... | |
| virtual void | setRecvBufferSize (int recvBufferSize) |
| 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 sendBufferSize) |
| 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 if ProxyForwarding is to be used. More... | |
| virtual void | setViaList (nACL *pAcl) |
| Commits the nACL object passed in with the Realm Server. More... | |
| virtual std::string | toString () |
| Return a string representation of the interface details. More... | |
| virtual bool | useForProxyForward () |
| Returns true if proxy forwarding is enabled. More... | |
| virtual bool | 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.
| com::pcbsys::nirvana::nAdminAPI::nInterface::nInterface | ( | fDriverConfig * | pCfg, |
| nInterfaceManager * | pIm | ||
| ) |
Creates a new nInterface object from the supplied fDriverConfig and nInterfaceManager.
| *pCfg | the fDriverConfig associated with this interface |
| *pIm | the Interface Manager for this interface |
| bool com::pcbsys::nirvana::nAdminAPI::nInterface::canAdvertise | ( | ) |
Will this interface be used by other realms to send client redirects to.
|
virtual |
Compares the name of this interface with the string parameter.
| item | the string name to compare to this interface name |
|
virtual |
Compares this nInterface object with another object.
| an | nInterface object |
|
virtual |
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
|
virtual |
Get the adapter that this interface will use.
Reserved interfaces are
0.0.0.0 - Bind to all physical interfaces on the machine 127.0.0.1 - Bind to local loopback
|
virtual |
Returns the number of milliseconds that the remote client has to authenticate with the server before the server closes the communications with the client.
|
virtual |
The number of socket connect requests that the Operating System will queue before sending a reject to the remote client.
|
virtual |
Get the name of this interface.
This is the unique name for this interface on the realm
|
virtual |
Get the port that this interface will bind to at startup.
|
virtual |
Returns the protocol string used by this interface.
Can be one of nsp, nsps, nhps or nhp
|
virtual |
Return the socket buffer size in bytes used by this interface when receiving data.
|
virtual |
Returns the number of select threads used by NIO.
|
virtual |
Return the socket buffer size in bytes used by this interface when sending data.
|
virtual |
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
|
virtual |
Get the URL that specifies this interface.
It is made up from the protocol the adapter and port
|
virtual |
|
virtual |
Returns whether NIO is enabled on this interface.
|
virtual |
Returns whether this interface can be used by clients to connect.
|
virtual |
Returns whether this interface is allowed to be used in inter realm / cluster communication.
|
virtual |
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 |
|
virtual |
Change the current advertise status for this interface.
| flag | True or False |
|
virtual |
Sets whether this interface can accept client connections or not.
| clientconnections | whether this interface can be used by clients |
|
virtual |
Set whether NIO is enabled on the interface.
| allowNIO | whether NIO is enabled |
|
virtual |
Changes the number of milliseconds that the remote client has to authenticate with the server.
| timeout | time in milliseconds |
|
virtual |
Change the current Autostart status for this interface.
| flag | True or False |
|
virtual |
Changes the number of connections to queue before the Operating System will send rejects to the remote client.
| backlog | Must be between 1 and 100 |
|
virtual |
Sets whether this interface is allowed to be used in inter realm / cluster communication.
| interealmAllow | whether this interface is allowed for cluster commincation |
|
virtual |
Set the Interface Manager.
| pIm | the interface manager to use |
|
virtual |
Set the socket buffer size in bytes used by this interface when receiving data.
| recvBufferSize | the inbound socket buffer size in bytes used by this interface |
|
virtual |
Sets the number of select threads used by NIO.
| selectThreadSize | the number of select threads used |
|
virtual |
Set the socket buffer size in bytes used by this interface when sending data.
| sendBufferSize | the size to set the outbound buffer size to |
|
virtual |
Changes the thread pool size handling the client connections.
| count | Must be between 1 and 5 inclussive |
|
virtual |
Set if ProxyForwarding is to be used.
| useForproxyForward | use Proxy forwarding if true |
|
virtual |
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.
| pAcl | 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 |
|
virtual |
Return a string representation of the interface details.
|
virtual |
Returns true if proxy forwarding is enabled.
|
virtual |
Will this interface automatically be started when the Realm Server starts.