InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > %Net.Remote.Gateway

%Net.Remote.Gateway

class %Net.Remote.Gateway extends %Library.RegisteredObject

Property Inventory

Method Inventory

Parameters

final parameter ADDTOCURRENTCLASSPATH = YP;
final parameter CONNECT = Y0;
Messages
final parameter DISCONNECT = Y4;
final parameter EXCEPTIONRAISED = Y5;
final parameter EXECUTEMETHOD = Y1;
final parameter GENERATECLASSES = Y2;
final parameter GETAVAILABLECLASSES = YC;
final parameter GETOBJECT = Y3;
final parameter GETTIMESTAMP = YT;
parameter INPUTTIMEOUT = 30;
final parameter JAVASERVICE = YK;
final parameter LOADCOSCLASS = YL;
final parameter LOADJAVACLASS = YZ;
final parameter LOADJAVACLASSSYNCH = YW;
final parameter OBJECTCREATED = Y9;
final parameter PING = YQ;
final parameter SHUTDOWN = Y6;
final parameter SUCCESS = YY;

Properties

property AttemptReconnect as %Boolean [ InitialExpression = 0 ];
Property methods: AttemptReconnectDisplayToLogical(), AttemptReconnectGet(), AttemptReconnectIsValid(), AttemptReconnectLogicalToDisplay(), AttemptReconnectNormalize(), AttemptReconnectSet()
property Closed as %Boolean;
Property methods: ClosedDisplayToLogical(), ClosedGet(), ClosedIsValid(), ClosedLogicalToDisplay(), ClosedNormalize(), ClosedProxiesDisplayToLogical(), ClosedProxiesGet(), ClosedProxiesIsValid(), ClosedProxiesLogicalToDisplay(), ClosedProxiesLogicalToOdbc(), ClosedProxiesNormalize(), ClosedProxiesSet(), ClosedSet()
property ClosedProxies as %String [ MultiDimensional ];
Property methods: ClosedProxiesDisplayToLogical(), ClosedProxiesGet(), ClosedProxiesIsValid(), ClosedProxiesLogicalToDisplay(), ClosedProxiesLogicalToOdbc(), ClosedProxiesNormalize(), ClosedProxiesSet()
property CurrentDevice as %String (TRUNCATE = 1);
Property methods: CurrentDeviceDisplayToLogical(), CurrentDeviceGet(), CurrentDeviceIsValid(), CurrentDeviceLogicalToDisplay(), CurrentDeviceLogicalToOdbc(), CurrentDeviceNormalize(), CurrentDeviceSet(), CurrentDeviceStackDisplayToLogical(), CurrentDeviceStackGet(), CurrentDeviceStackIsValid(), CurrentDeviceStackLogicalToDisplay(), CurrentDeviceStackLogicalToOdbc(), CurrentDeviceStackNormalize(), CurrentDeviceStackSet()
property CurrentDeviceStack as %String (TRUNCATE = 1) [ MultiDimensional ];
Used by GatewayLight to save current device multiple times in case of reentrancy
Property methods: CurrentDeviceStackDisplayToLogical(), CurrentDeviceStackGet(), CurrentDeviceStackIsValid(), CurrentDeviceStackLogicalToDisplay(), CurrentDeviceStackLogicalToOdbc(), CurrentDeviceStackNormalize(), CurrentDeviceStackSet()
property DisableOutputRedirect as %Boolean;
Property methods: DisableOutputRedirectDisplayToLogical(), DisableOutputRedirectGet(), DisableOutputRedirectIsValid(), DisableOutputRedirectLogicalToDisplay(), DisableOutputRedirectNormalize(), DisableOutputRedirectSet()
property GatewayDevice as %String (TRUNCATE = 1);
Property methods: GatewayDeviceDisplayToLogical(), GatewayDeviceGet(), GatewayDeviceIsValid(), GatewayDeviceLogicalToDisplay(), GatewayDeviceLogicalToOdbc(), GatewayDeviceNormalize(), GatewayDeviceSet()
property Namespace as %String (TRUNCATE = 1);
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property ProtocolVersion as %Integer;
Property methods: ProtocolVersionDisplayToLogical(), ProtocolVersionGet(), ProtocolVersionIsValid(), ProtocolVersionLogicalToDisplay(), ProtocolVersionNormalize(), ProtocolVersionSet()
property ProxyObjectHolder as %Library.RawString [ MultiDimensional ];
Property methods: ProxyObjectHolderGet(), ProxyObjectHolderIsValid(), ProxyObjectHolderSet()
property SHMConnectString as %String;
Property methods: SHMConnectStringDisplayToLogical(), SHMConnectStringGet(), SHMConnectStringIsValid(), SHMConnectStringLogicalToDisplay(), SHMConnectStringLogicalToOdbc(), SHMConnectStringNormalize(), SHMConnectStringSet()
property SequenceNumber as %Integer [ MultiDimensional ];
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property connectClassPaths as %ListOfDataTypes [ Transient ];
Property methods: connectClassPathsGet(), connectClassPathsGetObject(), connectClassPathsGetObjectId(), connectClassPathsGetSwizzled(), connectClassPathsIsEmpty(), connectClassPathsIsValid(), connectClassPathsNewObject(), connectClassPathsSet(), connectClassPathsSetObject(), connectClassPathsSetObjectId(), connectClassPathsUnSwizzle()
property connectParameters as %String) [ Transient ];
Property methods: connectParametersDisplayToLogical(), connectParametersGet(), connectParametersIsValid(), connectParametersLogicalToDisplay(), connectParametersLogicalToOdbc(), connectParametersNormalize(), connectParametersSet()

Methods

final method %AddToCurrentClassPath(paths As %ListOfDataTypes, useSystemLoader As %Boolean = 0) as %Status [ Language = objectscript ]
Add to current classpath
classmethod %Benchmark(port As %Integer, options As %String = "") as %Numeric [ Language = objectscript ]
classmethod %BenchmarkOneJob(port, index="", iterations=1000000, language="java", type="shm", action="echo", mode="zobjexport") [ Language = objectscript ]
final method %ClassForName(className As %String) as %Status [ Language = objectscript ]
Calls Class.forName
final method %ClassForNameSynch(className As %String) as %Status [ Language = objectscript ]
method %ClearGatewayDevice() [ Language = objectscript ]
final method %Connect(host As %String = "127.0.0.1", port As %Integer, namespace As %String = $namespace, timeout As %Numeric = 5, additionalClassPaths As %ListOfDataTypes = "", sslConfiguration As %String = "", Output isUsingSharedMemory, useSharedMemoryIfPossible As %Boolean = 0) as %Status [ Language = objectscript ]
Connect and handshake
classmethod %CreateReverseGateway(device, protocol) as %Net.Remote.Gateway [ Language = objectscript ]
final classmethod %DeregisterSuperServer(port As %String, namespace As %String) [ Language = objectscript ]
final method %Disconnect() as %Status [ Language = objectscript ]
Close the connection
final classmethod %ExpressImport(name As %String, port As %Integer, host As %String = "127.0.0.1", silent As %Boolean = 0, additionalClassPaths As %ListOfDataTypes = "", exclusions As %ListOfDataTypes = "") as %ListOfDataTypes [ Language = objectscript ]
method %GetAllClasses(jarFileName As %String, ByRef allClasses As %ListOfDataTypes, implements As %String = "") as %Status [ Language = objectscript ]
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
classmethod %GetContextGateway(device) as %Net.Remote.Gateway [ Language = objectscript ]
method %GetTimestamp(msgid As %Integer) [ Language = objectscript ]
final method %Import(javaClass As %String, ByRef javaClasses As %ListOfDataTypes, additionalClassPaths As %ListOfDataTypes = "", exclusions As %ListOfDataTypes = "", verbose As %Boolean = 0) as %Status [ Language = objectscript ]
Creates all necessary proxy classes
method %IsUsingSharedMemory() as %Boolean [ Language = objectscript ]
Returns true if the connection is open and connected over shared memory, false otherwise.
final classmethod %LoadCOSClass(verbose As %Boolean = 0, currentDevice As %String = "", gatewayDevice As %String = "") as %Status [ Language = objectscript ]
method %LostConnectionCleanup() as %Boolean [ Language = objectscript ]
Used to check if still connected to the gateway and mark as closed if no TCP connection
method %OnNew() as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() 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.

final classmethod %Ping(host As %String, port As %Integer, timeout As %Numeric = 5, reuseSocket As %Boolean = 0, ByRef gatewayDevice As %String = "") as %Status [ Language = objectscript ]
Check if SuperServer still alive.
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.
method %PopGatewayDevice() [ Language = objectscript ]
method %PushGatewayDevice() [ Language = objectscript ]
classmethod %RecastClass(classname, verbose) [ Language = objectscript ]
method %Reconnect() as %Status [ Language = objectscript ]
method %RegUpdate() [ Language = objectscript ]
final classmethod %RegisterSuperServer(port As %String, namespace As %String, pPassphraseList As %String = "") [ Language = objectscript ]
classmethod %ReleaseObjects(orefs) as %String [ Language = objectscript ]
final classmethod %RemoteService(host As %String, port As %Integer, serviceName As %String, arguments As %String, additionalClassPaths As %ListOfDataTypes = "") as %String [ Language = objectscript ]
classmethod %RetainObject(oref, gateway="") [ Language = objectscript ]
final method %ServiceRequest(serviceName As %String, arguments As %String, ByRef response As %String) as %Status [ Language = objectscript ]
classmethod %SetStatus(exception As %Exception.StatusException) as %Status [ Language = objectscript ]
final method %Shutdown() as %Status [ Language = objectscript ]
Shut down the Gateway
final classmethod %TerminateAllSuperServers() [ Language = objectscript ]
final classmethod %TerminateSuperServer(port As %String, namespace As %String, deregister As %Boolean) [ Language = objectscript ]

Inherited Members

Inherited Methods

Subclasses

Feedback