PropertiesCopy link to this section
property AttemptReconnect as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Property methods: AttemptReconnectDisplayToLogical(), AttemptReconnectGet(), AttemptReconnectIsValid(), AttemptReconnectLogicalToDisplay(), AttemptReconnectNormalize(), AttemptReconnectSet()
property Closed as %Boolean ;
Copy link to this section
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);
Copy link to this section
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);
Copy link to this section
Property methods: CurrentDeviceDisplayToLogical(), CurrentDeviceGet(), CurrentDeviceIsValid(), CurrentDeviceLogicalToDisplay(), CurrentDeviceLogicalToOdbc(), CurrentDeviceNormalize(), CurrentDeviceSet()
property DBSRVProtocol as %Integer ;
Copy link to this section
Property methods: DBSRVProtocolDisplayToLogical(), DBSRVProtocolGet(), DBSRVProtocolIsValid(), DBSRVProtocolLogicalToDisplay(), DBSRVProtocolNormalize(), DBSRVProtocolSet()
property GatewayDevice as %String (TRUNCATE = 1);
Copy link to this section
Property methods: GatewayDeviceDisplayToLogical(), GatewayDeviceGet(), GatewayDeviceIsValid(), GatewayDeviceLogicalToDisplay(), GatewayDeviceLogicalToOdbc(), GatewayDeviceNormalize(), GatewayDeviceSet()
property Namespace as %String (TRUNCATE = 1);
Copy link to this section
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property Protocol as %Integer ;
Copy link to this section
Property methods: ProtocolDisplayToLogical(), ProtocolGet(), ProtocolIsValid(), ProtocolLogicalToDisplay(), ProtocolNormalize(), ProtocolSet()
property Proxies as list of %String (TRUNCATE = 1);
Copy link to this section
Property methods: ProxiesBuildValueArray(), ProxiesCollectionToDisplay(), ProxiesCollectionToOdbc(), ProxiesDisplayToCollection(), ProxiesDisplayToLogical(), ProxiesGet(), ProxiesGetObject(), ProxiesGetObjectId(), ProxiesGetSwizzled(), ProxiesIsValid(), ProxiesLogicalToDisplay(), ProxiesLogicalToOdbc(), ProxiesNormalize(), ProxiesOdbcToCollection(), ProxiesSet(), ProxiesSetObject(), ProxiesSetObjectId()
property connectClassPaths as %ListOfDataTypes [ Transient ];
Copy link to this section
Property methods: connectClassPathsGet(), connectClassPathsGetObject(), connectClassPathsGetObjectId(), connectClassPathsGetSwizzled(), connectClassPathsIsEmpty(), connectClassPathsIsValid(), connectClassPathsNewObject(), connectClassPathsSet(), connectClassPathsSetObject(), connectClassPathsSetObjectId(), connectClassPathsUnSwizzle()
property connectParameters as %String ) [ Transient ];
Copy link to this section
Property methods: connectParametersDisplayToLogical(), connectParametersGet(), connectParametersIsValid(), connectParametersLogicalToDisplay(), connectParametersLogicalToOdbc(), connectParametersNormalize(), connectParametersSet()
MethodsCopy link to this section
Add to current classpath
final method %ClassForName(className As %String ) as %Status
Copy link to this section
Calls Class.forName
final method %ClassForNameSynch(className As %String ) as %Status
Copy link to this section
Connect and handshake
final classmethod %DeregisterSuperServer(port As %String , namespace As %String )
Copy link to this section
final method %Disconnect() as %Status
Copy link to this section
Close the connection
method %GetTimestamp()
Copy link to this section
Creates all necessary proxy classes
final classmethod %LoadCOSClass() as %Status
Copy link to this section
method %LostConnectionCleanup() as %Boolean
Copy link to this section
Used to check if still connected to the gateway and mark as closed if no TCP connection
method %OnNew() as %Status
Copy link to this section
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.
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
Copy link to this section
method %RegUpdate()
Copy link to this section
final classmethod %RegisterSuperServer(port As %String , namespace As %String , pPassphraseList As %String = "")
Copy link to this section
final method %Shutdown() as %Status
Copy link to this section
Shut down the Gateway
final classmethod %TerminateAllSuperServers()
Copy link to this section
final classmethod %TerminateSuperServer(port As %String , namespace As %String , deregister As %Boolean )
Copy link to this section