Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%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 PROTOCOLVERSION = 0;
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(), ClosedProxiesBuildValueArray(), ClosedProxiesCollectionToDisplay(), ClosedProxiesCollectionToOdbc(), ClosedProxiesDisplayToCollection(), ClosedProxiesDisplayToLogical(), ClosedProxiesGet(), ClosedProxiesGetObject(), ClosedProxiesGetObjectId(), ClosedProxiesGetSwizzled(), ClosedProxiesIsValid(), ClosedProxiesLogicalToDisplay(), ClosedProxiesLogicalToOdbc(), ClosedProxiesNormalize(), ClosedProxiesOdbcToCollection(), ClosedProxiesSet(), ClosedProxiesSetObject(), ClosedProxiesSetObjectId(), ClosedSet()
property ClosedProxies as list of %String (TRUNCATE = 1);
Property methods: ClosedProxiesBuildValueArray(), ClosedProxiesCollectionToDisplay(), ClosedProxiesCollectionToOdbc(), ClosedProxiesDisplayToCollection(), ClosedProxiesDisplayToLogical(), ClosedProxiesGet(), ClosedProxiesGetObject(), ClosedProxiesGetObjectId(), ClosedProxiesGetSwizzled(), ClosedProxiesIsValid(), ClosedProxiesLogicalToDisplay(), ClosedProxiesLogicalToOdbc(), ClosedProxiesNormalize(), ClosedProxiesOdbcToCollection(), ClosedProxiesSet(), ClosedProxiesSetObject(), ClosedProxiesSetObjectId()
property CurrentDevice as %String (TRUNCATE = 1);
Property methods: CurrentDeviceDisplayToLogical(), CurrentDeviceGet(), CurrentDeviceIsValid(), CurrentDeviceLogicalToDisplay(), CurrentDeviceLogicalToOdbc(), CurrentDeviceNormalize(), CurrentDeviceSet()
property DBSRVProtocol as %Integer;
Property methods: DBSRVProtocolDisplayToLogical(), DBSRVProtocolGet(), DBSRVProtocolIsValid(), DBSRVProtocolLogicalToDisplay(), DBSRVProtocolNormalize(), DBSRVProtocolSet()
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 Protocol as %Integer;
Property methods: ProtocolDisplayToLogical(), ProtocolGet(), ProtocolIsValid(), ProtocolLogicalToDisplay(), ProtocolNormalize(), ProtocolSet()
property Proxies as list of %String (TRUNCATE = 1);
Property methods: ProxiesBuildValueArray(), ProxiesCollectionToDisplay(), ProxiesCollectionToOdbc(), ProxiesDisplayToCollection(), ProxiesDisplayToLogical(), ProxiesGet(), ProxiesGetObject(), ProxiesGetObjectId(), ProxiesGetSwizzled(), ProxiesIsValid(), ProxiesLogicalToDisplay(), ProxiesLogicalToOdbc(), ProxiesNormalize(), ProxiesOdbcToCollection(), ProxiesSet(), ProxiesSetObject(), ProxiesSetObjectId()
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) 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
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 = "") 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(jarFileOrDirectoryName As %String, ByRef allClasses As %ListOfDataTypes) as %Status
method %GetTimestamp()
final method %Import(javaClass As %String, ByRef javaClasses As %ListOfDataTypes, additionalClassPaths As %ListOfDataTypes = "", exclusions As %ListOfDataTypes = "") as %Status
Creates all necessary proxy classes
final classmethod %LoadCOSClass() 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
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
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 %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)

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab