com.pcbsys.nirvana.nAdminAPI.nHTTPInterface Class Reference

This class contains all the configuration required by the Nirvana Realm server to start and control the HTTP interface. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nHTTPInterface:

com.pcbsys.nirvana.nAdminAPI.nInterface com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface

Public Member Functions

void enabled_HTTP_1_1 (boolean flag)
 set the use of HTTP1.1
void enabledWebSockets (boolean flag)
 Sets the use of WebSockets.
Long getAjaxLPActiveDelay ()
 Returns the time to wait (for additional events) before delivering to Long Poll style subscribers.
Long getAjaxLPIdleDelay ()
 Returns the time to wait before returning from a Long Poll call if no events have been received.
String getInitialJavascript ()
 Returns the javascript code that will be sent to comet / iframe users on initialisation.
Vector getPlugin ()
 Get the name of the plugin to use.
boolean isHTTP_1_1_Enabled ()
 Returns true if HTTP 1.1 is enabled.
boolean isNativeCometAllowed ()
 Returns whether this interface has javascript enabled or not.
boolean isWebSocketEnabled ()
 Returns true if WebSockets are enabled.
 nHTTPInterface (String adapter, int port, boolean autostart) throws nAdminIllegalArgumentException
 Creates a HTTP interface on the supplied adapter:port with the supplied autostart flag.
 nHTTPInterface (String adapter, int port) throws nAdminIllegalArgumentException
 Creates a HTTP interface on the supplied adapter:port.
void setAjaxLPActiveDelay (Long ajaxLPActiveDelay)
 Sets the time to wait (for additional events) before delivering to Long Poll style subscribers.
void setAjaxLPIdleDelay (Long ajaxLPIdleDelay)
 Set the time to wait before returning from a Long Poll call if no events have been received.
void setInitialJavascript (String initialJavascript)
 Set the javascript code that will be sent to comet / iframe users on initialisation.
void setNativeCometAllowed (boolean nativeCometAllowed)
 Sets whether javascript is enabled on the interface.
void setPlugin (Vector config)
 Get the name of the plugin to use.

Detailed Description

This class contains all the configuration required by the Nirvana Realm server to start and control the HTTP interface.

Constructor & Destructor Documentation

com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.nHTTPInterface ( String  adapter,
int  port 
) throws nAdminIllegalArgumentException

Creates a HTTP interface on the supplied adapter:port.

Parameters:
adapter to bind to
port to bind to
Exceptions:
nAdminIllegalArgumentException if adapter is null or the port range is invalid

com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.nHTTPInterface ( String  adapter,
int  port,
boolean  autostart 
) throws nAdminIllegalArgumentException

Creates a HTTP interface on the supplied adapter:port with the supplied autostart flag.

Parameters:
adapter to bind to
port to bind to
autostart Should be autostarted or not
Exceptions:
nAdminIllegalArgumentException if adapter is null or the port range is invalid

Member Function Documentation

void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.enabled_HTTP_1_1 ( boolean  flag  ) 

set the use of HTTP1.1

Parameters:
flag if true, interface will use HTTP 1.1

void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.enabledWebSockets ( boolean  flag  ) 

Sets the use of WebSockets.

Parameters:
flag if true, interface will use websockets

Long com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.getAjaxLPActiveDelay (  ) 

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 (  ) 

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.getInitialJavascript (  ) 

Returns the javascript code that will be sent to comet / iframe users on initialisation.

This can be used, for example to set document.domain

Returns:
the javascript code to send on initialisation

Vector com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.getPlugin (  ) 

Get the name of the plugin to use.

Not yet implemented. For future use ONLY

boolean com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.isNativeCometAllowed (  ) 

Returns whether this interface has javascript enabled or not.

Returns:
whether this interface has javascript enabled

void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setAjaxLPActiveDelay ( Long  ajaxLPActiveDelay  ) 

Sets the time to wait (for additional events) before delivering to Long Poll style subscribers.

Parameters:
ajaxLPActiveDelay the time to wait in milliseconds

void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setAjaxLPIdleDelay ( Long  ajaxLPIdleDelay  ) 

Set the time to wait before returning from a Long Poll call if no events have been received.

Parameters:
ajaxLPIdleDelay the time in milliseconds

void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setInitialJavascript ( String  initialJavascript  ) 

Set the javascript code that will be sent to comet / iframe users on initialisation.

This can be used, for example, to set document.domain

Parameters:
initialJavascript the javascript code to send to comet users on initialisation

void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setNativeCometAllowed ( boolean  nativeCometAllowed  ) 

Sets whether javascript is enabled on the interface.

Parameters:
nativeCometAllowed true to enable javascript communication via this interface

void com.pcbsys.nirvana.nAdminAPI.nHTTPInterface.setPlugin ( Vector  config  ) 

Get the name of the plugin to use.

Not yet implemented. For future use ONLY

Parameters:
config the configuration of the plugin