Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%Net] >  [Remote] >  [Gateway]
Private  Storage   

class %Net.Remote.Gateway extends %RegisteredObject

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
18 12 31


Summary

Properties
AttemptReconnect Closed ClosedProxies CurrentDevice
CurrentDeviceStack GatewayDevice Namespace ProtocolVersion
SHMConnectString SequenceNumber connectClassPaths connectParameters

Methods
%AddToCurrentClassPath %AddToSaveSet %ClassForName %ClassForNameSynch
%ClassIsLatestVersion %ClassName %ClearGatewayDevice %Connect
%ConstructClone %DeregisterSuperServer %Disconnect %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %ExpressImport %Extends
%GetAllClasses %GetContextGateway %GetParameter %GetTimestamp
%Import %IsA %IsModified %IsUsingSharedMemory
%LoadCOSClass %LostConnectionCleanup %New %NormalizeObject
%ObjectModified %OnNew %OriginalNamespace %PackageName
%Ping %PopGatewayDevice %PushGatewayDevice %Reconnect
%RegUpdate %RegisterSuperServer %RemoteService %RemoveFromSaveSet
%SerializeObject %ServiceRequest %SetModified %SetStatus
%Shutdown %TerminateAllSuperServers %TerminateSuperServer %ValidateObject

Subclasses
%Net.Remote.Java.JavaGateway %Net.Remote.Java.XSLTGateway

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 Closed as %Boolean;
• property ClosedProxies as list of %String(TRUNCATE=1);
• property CurrentDevice as %String(TRUNCATE=1);
• property CurrentDeviceStack as %String(TRUNCATE=1) [ MultiDimensional ];
Used by GatewayLight to save current device multiple times in case of reentrancy
• property GatewayDevice as %String(TRUNCATE=1);
• property Namespace as %String(TRUNCATE=1);
• property ProtocolVersion as %Integer;
• property SHMConnectString as %String;
• property SequenceNumber as %Integer [ MultiDimensional ];
• property connectClassPaths as %ListOfDataTypes [ Transient ];
• property connectParameters as %String(MAXLEN="") [ Transient ];

Methods

• final method %AddToCurrentClassPath(paths As %ListOfDataTypes) as %Status
Add to current classpath
• final method %ClassForName(className As %String) as %Status
Calls Class.forName
• final method %ClassForNameSynch(className As %String) as %Status
• method %ClearGatewayDevice()
• 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
Connect and handshake
• final classmethod %DeregisterSuperServer(port As %String, namespace As %String)
• final method %Disconnect() as %Status
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
• method %GetAllClasses(jarFileName As %String, ByRef allClasses As %ListOfDataTypes, implements As %String = "") as %Status
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() as %Net.Remote.Gateway
• method %GetTimestamp(msgid As %Integer)
• final method %Import(javaClass As %String, ByRef javaClasses As %ListOfDataTypes, additionalClassPaths As %ListOfDataTypes = "", exclusions As %ListOfDataTypes = "", verbose As %Boolean = 0) as %Status
Creates all necessary proxy classes
• method %IsUsingSharedMemory() as %Boolean
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
• method %LostConnectionCleanup() as %Boolean
Used to check if still connected to the gateway and mark as closed if no TCP connection
• method %OnNew() as %Status
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
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()
• method %PushGatewayDevice()
• method %Reconnect() as %Status
• method %RegUpdate()
• final classmethod %RegisterSuperServer(port As %String, namespace As %String, pPassphraseList As %String = "")
• final classmethod %RemoteService(host As %String, port As %Integer, serviceName As %String, arguments As %String, additionalClassPaths As %ListOfDataTypes = "") as %String
• final method %ServiceRequest(serviceName As %String, arguments As %String, ByRef response As %String) as %Status
• classmethod %SetStatus(exception As %Exception.StatusException) as %Status
• final method %Shutdown() as %Status
Shut down the Gateway
• final classmethod %TerminateAllSuperServers()
• final classmethod %TerminateSuperServer(port As %String, namespace As %String, deregister As %Boolean)


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.