Service Class Reference

This class contains methods to start, monitor and stop an External Language Server for Java or .NET. More...

Inheritance diagram for Service:

Collaboration diagram for Service:

Static Public Member Functions
_.Library.Boolean	IsGatewayRunning (_.Library.String host, _.Library.String port, _.Library.Boolean pVerbose, _.Library.Status pSC, _.Library.Boolean pPing, _.Library.String allowedip, _.Library.String sslConfiguration)
	Return true if Gateway is running, based on the status of the TCP port, and responsiveness to PING More...
_.Library.Status	PingGateway (_.Library.String pPort, _.Library.String pAddress, _.Library.Integer pTimeout, _.Library.Boolean pReuseSocket, _.Library.Boolean pVerbose)
	"Ping" the Gateway server to check if it is alive. More...
_.Library.Status	StopGateway (_.Library.String pName, _.Library.Boolean pVerbose, _.Library.Boolean pStopMonitor, _.Library.Integer pTimeout)
	Stop the External Language Server whose definition is identified by pName. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

This class contains methods to start, monitor and stop an External Language Server for Java or .NET.

Member Function Documentation

IsGatewayRunning()

_.Library.Boolean IsGatewayRunning ( _.Library.String  host, _.Library.String  port, _.Library.Boolean  pVerbose, _.Library.Status  pSC, _.Library.Boolean  pPing, _.Library.String  allowedip, _.Library.String  sslConfiguration  )

static

Return true if Gateway is running, based on the status of the TCP port, and responsiveness to PING

If the port is not in use, then Gateway is not running on the port, otherwise, we will PING the port. Parameters pPing is deprecated.

PingGateway()

_.Library.Status PingGateway ( _.Library.String  pPort, _.Library.String  pAddress, _.Library.Integer  pTimeout, _.Library.Boolean  pReuseSocket, _.Library.Boolean  pVerbose  )

static

"Ping" the Gateway server to check if it is alive.

If pReuseSocket is true (the default is false), it will try to reuse the TCP device and in case the TCP connection has become invalid it will reconnect.
Instead of using this method it is recommended to instantiate or use an existing Net.Remote.Gateway client and Connect(), call Ping() and then Disconnect().

StopGateway()

_.Library.Status StopGateway ( _.Library.String  pName, _.Library.Boolean  pVerbose, _.Library.Boolean  pStopMonitor, _.Library.Integer  pTimeout  )

static

Stop the External Language Server whose definition is identified by pName.

To supress write of progress messages, pass pVerbose = 0.

pName : gateway name pVerbose : flag to enable verbose logging, 0 by default pStopMonitor : flag to enable monitoring of gateway shutdown process, no longer in use pTimeout : soft shutdown timeout in seconds, 0 by default