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