This class contains all the configuration required by the Nirvana Realm server to start and control the HTTP interface. More...
Public Member Functions | |
| void | enabled_HTTP_1_1 (bool flag) |
| summary>set the use of HTTP1.1 More... | |
| void | enabledWebSockets (bool flag) |
| summary>Sets the use of WebSockets More... | |
| long | getAjaxLPActiveDelay () |
| summary>Returns the time to wait (for additional events) before delivering to Long Poll style subscribers More... | |
| long | getAjaxLPIdleDelay () |
| summary>Returns the time to wait before returning from a Long Poll call if no events have been received More... | |
| string | getAllowedOrigins () |
| Returns the currently set allowed origins for CORS. More... | |
| List< nCustomHeader > | getCustomHeaders () |
| Returns a List of nCustomHeader which will be sent to javascript clients More... | |
| int | getMinimumBytesBeforeGZIP () |
| The minimum number of bytes in a packet before GZIP is enabled, default 1000. More... | |
| virtual ArrayList | getPlugin () |
| Get the name of the plugin to use. More... | |
| bool | isAllowCrossOriginCredentials () |
| This allows credentials header to be sent with CORS requests. More... | |
| bool | isEnableGZIP () |
| Enable GZIP compression for javascript longpoll connections. More... | |
| bool | isHTTP_1_1_Enabled () |
| summary>Returns true if HTTP 1.1 is enabled. More... | |
| bool | isNativeCometAllowed () |
| Returns whether this interface has javascript enabled or not More... | |
| bool | isWebSocketEnabled () |
| summary>Returns true if WebSockets are enabled More... | |
| nHTTPInterface (string adapter, int port) | |
| Creates a HTTP interface on the supplied adapter:port More... | |
| nHTTPInterface (string adapter, int port, bool autostart) | |
| Creates a HTTP interface on the supplied adapter:port with the supplied autostart flag More... | |
| void | setAjaxLPActiveDelay (long ajaxLPActiveDelay) |
| summary>Sets the time to wait (for additional events) before delivering to Long Poll style subscribers More... | |
| void | setAjaxLPIdleDelay (long ajaxLPIdleDelay) |
| summary>Set the time to wait before returning from a Long Poll call if no events have been received More... | |
| void | setAllowCrossOriginCredentials (bool allow) |
| Set to true to send the allow credentails header to be sent with CORS requests. More... | |
| void | setAllowedOrigins (string allowed) |
| Sets the Allowed Origins for CORS. More... | |
| void | setCustomHeaders (List< nCustomHeader > customHeaders) |
| Sets the custom headers that will be sent to javascript clients More... | |
| void | setEnableGZIP (bool flag) |
| Sets whether or not GZIP compression is enabled for javascript longpoll connections. More... | |
| void | setMinimumBytesBeforeGZIP (int length) |
| The minimum number of bytes in a packet before GZIP is enabled, default 1000. More... | |
| void | setNativeCometAllowed (bool isNativeCometAllowed) |
| Sets whether javascript is enabled on the interface More... | |
| virtual void | setPlugin (ArrayList config) |
| Get the name of the plugin to use. 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... | |
This class contains all the configuration required by the Nirvana Realm server to start and control the HTTP interface.
| com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.nHTTPInterface | ( | string | adapter, |
| int | port | ||
| ) |
Creates a HTTP interface on the supplied adapter:port
| adapter | to bind to |
| port | to bind to |
| nAdminIllegalArgumentException | if adapter is null or the port range is invalid |
| com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.nHTTPInterface | ( | string | adapter, |
| int | port, | ||
| bool | autostart | ||
| ) |
Creates a HTTP interface on the supplied adapter:port with the supplied autostart flag
| adapter | to bind to |
| port | to bind to |
| autostart | Should be autostarted or not |
| nAdminIllegalArgumentException | if adapter is null or the port range is invalid |
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.enabled_HTTP_1_1 | ( | bool | flag | ) |
summary>set the use of HTTP1.1
param name="flag"> if true, interface will use HTTP 1.1
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.enabledWebSockets | ( | bool | flag | ) |
summary>Sets the use of WebSockets
param name="flag"> if true, interface will use websockets
| long com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.getAjaxLPActiveDelay | ( | ) |
summary>Returns the time to wait (for additional events) before delivering to Long Poll style subscribers
returns> the time in milliseconds
| long com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.getAjaxLPIdleDelay | ( | ) |
summary>Returns the time to wait before returning from a Long Poll call if no events have been received
returns> the time in milliseconds
| string com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.getAllowedOrigins | ( | ) |
Returns the currently set allowed origins for CORS.
| List<nCustomHeader> com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.getCustomHeaders | ( | ) |
Returns a List of nCustomHeader which will be sent to javascript clients
| int com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.getMinimumBytesBeforeGZIP | ( | ) |
The minimum number of bytes in a packet before GZIP is enabled, default 1000.
|
virtual |
Get the name of the plugin to use.
Not yet implemented. For future use ONLY
| bool com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.isAllowCrossOriginCredentials | ( | ) |
This allows credentials header to be sent with CORS requests.
| bool com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.isEnableGZIP | ( | ) |
Enable GZIP compression for javascript longpoll connections.
| bool com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.isHTTP_1_1_Enabled | ( | ) |
summary>Returns true if HTTP 1.1 is enabled.
returns>true if HTTP 1.1 is enabled
| bool com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.isNativeCometAllowed | ( | ) |
Returns whether this interface has javascript enabled or not
| bool com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.isWebSocketEnabled | ( | ) |
summary>Returns true if WebSockets are enabled
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setAjaxLPActiveDelay | ( | long | ajaxLPActiveDelay | ) |
summary>Sets the time to wait (for additional events) before delivering to Long Poll style subscribers
param name="ajaxLPActiveDelay"> the time to wait in milliseconds
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setAjaxLPIdleDelay | ( | long | ajaxLPIdleDelay | ) |
summary>Set the time to wait before returning from a Long Poll call if no events have been received
param name="ajaxLPIdleDelay"> the time in milliseconds
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setAllowCrossOriginCredentials | ( | bool | allow | ) |
Set to true to send the allow credentails header to be sent with CORS requests.
| myAllowCrossOriginCredentials | true to enable header |
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setAllowedOrigins | ( | string | allowed | ) |
Sets the Allowed Origins for CORS.
| allowedOrigins | a comma seperated list of origins allowed with CORS or * to allow all |
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setCustomHeaders | ( | List< nCustomHeader > | customHeaders | ) |
Sets the custom headers that will be sent to javascript clients
| customHeaders | List of nCustomHeader |
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setEnableGZIP | ( | bool | flag | ) |
Sets whether or not GZIP compression is enabled for javascript longpoll connections.
| enableGZIP | set to true to enable |
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setMinimumBytesBeforeGZIP | ( | int | length | ) |
The minimum number of bytes in a packet before GZIP is enabled, default 1000.
| minimumBytesBeforeGZIP | the number of bytes before GZIPing a packet, as smaller packets do not benefit due to CPU overhead. |
| void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setNativeCometAllowed | ( | bool | isNativeCometAllowed | ) |
Sets whether javascript is enabled on the interface
| isNativeCometAllowed | true to enable javascript communication via this interface |
|
virtual |
Get the name of the plugin to use.
Not yet implemented. For future use ONLY
| config | the configuration of the plugin |