IRISLIB database
Gateway Class Reference
Inheritance diagram for Gateway:
Collaboration diagram for Gateway:

Public Member Functions

_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
- 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 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 OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 AttemptReconnect
   More...
 
 Closed
   More...
 
 ClosedProxies
   More...
 
 CurrentDevice
   More...
 
 CurrentDeviceStack
 Used by GatewayLight to save current device multiple times in case of reentrancy. More...
 
 DisableOutputRedirect
   More...
 
 ExternalLanguage
   More...
 
 ExternalLanguageVersion
   More...
 
 GatewayDevice
   More...
 
 IsUsingSharedMemory
   More...
 
 Namespace
   More...
 
 OutputRedirectHandler
   More...
 
 ProtocolVersion
   More...
 
 ProxyObjectHolder
   More...
 
 SHMConnectString
   More...
 
 SequenceNumber
   More...
 
 connectClassPaths
   More...
 
 connectParameters
   More...
 
 xdbcConnection
   More...
 

Static Public Attributes

 CONNECT = None
 Messages.
 
- 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...
 

Private Member Functions

_.Library.Status AddToCurrentClassPath (_.Library.ListOfDataTypes paths, _.Library.Boolean useProcessLoader)
 Add to current classpath.
 
_.Library.Status ClassForName (_.Library.String className)
 Calls Class.forName.
 
_.Library.Status Connect (_.Library.String host, _.Library.Integer port, _.Library.String namespace, _.Library.Numeric timeout, _.Library.ListOfDataTypes additionalClassPaths, _.Library.String sslConfiguration, isUsingSharedMemory, _.Library.Boolean useSharedMemoryIfPossible, _.Library.Boolean VerifySSLHostName)
 Connect to an External Language Server. More...
 
_.Library.Status Disconnect ()
 Close the connection.
 
_.Library.Status GetAllClasses (_.Library.String jarFileName, _.Library.ListOfDataTypes allClasses, _.Library.String implements)
 Use the implements parameter to limit the classes to those implementing a specific interface. More...
 
_.Library.Status Import (_.Library.String javaClass, _.Library.ListOfDataTypes javaClasses, _.Library.ListOfDataTypes additionalClassPaths, _.Library.ListOfDataTypes exclusions, _.Library.Boolean verbose)
 Creates all necessary proxy classes.
 
_.Library.Boolean IsUsingSharedMemory ()
 Returns true if the connection is open and connected over shared memory, false otherwise.
 
_.Library.Boolean LostConnectionCleanup ()
 Used to check if still connected to the gateway and mark as closed if no TCP connection.
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status Shutdown (timeout)
 Shut down the Gateway.
 

Static Private Member Functions

_.Library.ListOfDataTypes ExpressImport (_.Library.String name, _.Library.Integer port, _.Library.String host, _.Library.Boolean silent, _.Library.ListOfDataTypes additionalClassPaths, _.Library.ListOfDataTypes exclusions)
 Generate proxy classes for an External language module. More...
 
_.Library.Status Ping (_.Library.String host, _.Library.Integer port, _.Library.Numeric timeout, _.Library.Boolean reuseSocket, _.Library.String gatewayDevice, _.Library.String serverFullName, _.Library.String sslConfiguration)
 Check if an External Language Server still alive. More...
 

Member Function Documentation

◆ Connect()

_.Library.Status Connect ( _.Library.String  host,
_.Library.Integer  port,
_.Library.String  namespace,
_.Library.Numeric  timeout,
_.Library.ListOfDataTypes  additionalClassPaths,
_.Library.String  sslConfiguration,
  isUsingSharedMemory,
_.Library.Boolean  useSharedMemoryIfPossible,
_.Library.Boolean  VerifySSLHostName 
)
private

Connect to an External Language Server.

To connect to an External Language Server by name, please pass empty string as first argument and Gateway name as second argument. Please note if a ELS definition is secure, then connecting by ELS name is required. Connecting using host and port only works for unsecure External Language Servers.

◆ ExpressImport()

_.Library.ListOfDataTypes ExpressImport ( _.Library.String  name,
_.Library.Integer  port,
_.Library.String  host,
_.Library.Boolean  silent,
_.Library.ListOfDataTypes  additionalClassPaths,
_.Library.ListOfDataTypes  exclusions 
)
staticprivate

Generate proxy classes for an External language module.

To connect to an External Language Server by name, please pass empty string as first argument and Gateway name as second argument. Please note if a ELS definition is secure, then connecting by ELS name is required. Connecting using host and port only works for unsecure External Language Servers.

◆ GetAllClasses()

_.Library.Status GetAllClasses ( _.Library.String  jarFileName,
_.Library.ListOfDataTypes  allClasses,
_.Library.String  implements 
)
private

Use the implements parameter to limit the classes to those implementing a specific interface.

The interface must be declared either in isc-gateway, or jarFileName JAR file

◆ OnClose()

_.Library.Status OnClose ( )

This callback method is invoked by the <METHOD>Close</METHOD> method to.

provide notification that the current object is being closed.

The return value of this method is ignored.

Reimplemented from RegisteredObject.

◆ OnNew()

_.Library.Status OnNew ( )
private

This callback method is invoked by the <METHOD>New</METHOD> method to.

provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from New(). For example, if you're going to call New, passing 2 arguments, OnNew's signature could be:

Method OnNew(dob as Date = "", name as Name = "") as Status If instead of returning a Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of New method.

Reimplemented from RegisteredObject.

◆ Ping()

_.Library.Status Ping ( _.Library.String  host,
_.Library.Integer  port,
_.Library.Numeric  timeout,
_.Library.Boolean  reuseSocket,
_.Library.String  gatewayDevice,
_.Library.String  serverFullName,
_.Library.String  sslConfiguration 
)
staticprivate

Check if an External Language Server still alive.


To connect to an External Language Server by name, please pass empty string as first argument and Gateway name as second argument Please note if a ELS definition is secure, then connecting by ELS name is required. Connecting using host and port only works for unsecure External Language Servers When parameter reuseSocket is true (the default is false), the TCP socket will not be opened or closed and it is up to the caller must ensure that the device is already opened.

Member Data Documentation

◆ AttemptReconnect

AttemptReconnect

 

 

◆ Closed

Closed

 

 

◆ ClosedProxies

ClosedProxies

 

 

◆ CurrentDevice

CurrentDevice

 

 

◆ CurrentDeviceStack

CurrentDeviceStack

Used by GatewayLight to save current device multiple times in case of reentrancy.

 

◆ DisableOutputRedirect

DisableOutputRedirect

 

 

◆ ExternalLanguage

ExternalLanguage

 

 

◆ ExternalLanguageVersion

ExternalLanguageVersion

 

 

◆ GatewayDevice

GatewayDevice

 

 

◆ IsUsingSharedMemory

IsUsingSharedMemory

 

 

◆ Namespace

Namespace

 

 

◆ OutputRedirectHandler

OutputRedirectHandler

 

 

◆ ProtocolVersion

ProtocolVersion

 

 

◆ ProxyObjectHolder

ProxyObjectHolder

 

 

◆ SHMConnectString

SHMConnectString

 

 

◆ SequenceNumber

SequenceNumber

 

 

◆ connectClassPaths

connectClassPaths

 

 

◆ connectParameters

connectParameters

 

 

◆ xdbcConnection

xdbcConnection