- com
- pcbsys
- nirvana
- nAdminAPI
- nSocketInterface
Socket Interface class. More...
#include <nSocketInterface.h>
Public Member Functions | |
| nSocketInterface (fSocketConfig *pSock, nInterfaceManager *pIm) | |
| Creates a new Socket Interface with the supplied values. More... | |
 Public Member Functions inherited from com::pcbsys::nirvana::nAdminAPI::nInterface | |
| 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... | |
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.
| com::pcbsys::nirvana::nAdminAPI::nSocketInterface::nSocketInterface | ( | fSocketConfig * | pSock, |
| nInterfaceManager * | pIm | ||
| ) |
Creates a new Socket Interface with the supplied values.
| *pSock | The fSocketConfig to use |
| *pIm | The interface manager to use |
| autostart | Specifies whether to autostart this interface |