Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [TCP] >  [StatusService]
Private  Storage   

class EnsLib.TCP.StatusService extends Ens.BusinessService

Service class that supports a simple telnet interface for querying aspects of the status of the running Production Suitable for use in periodically checking from outside InterSystems IRIS (e.g. from a shell script) that the Production is running and in good condition

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 2


Summary

This is a Business Service class.

The associated Adapter class is EnsLib.TCP.TextLineInboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow Adapter
AlertGracePeriod AlertGroups AlertOnError
ArchiveIO BusinessPartner GenerateSuperSessionID
IOLogEntry InactivityTimeout ThrottleDelay

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetDeferredResponseToken
GetMsgHdrRequestKey GetProductionSettingValue GetProductionSettings GetPropertyConnections
GetSettings GetShadowInstance NewIOLogEntry OnError
OnGenerateSuperSession OnGetConnections OnInit OnKeepalive
OnMonitor OnProcessInput OnProductionStart OnProductionStop
OnTearDown PopulateSuperSession QueueName SaveIOLogEntry
SendAlert SendDeferredResponse SendRequestAsync SendRequestSync
isConfigRunning


Parameters

• parameter ADAPTER = "EnsLib.TCP.TextLineInboundAdapter";
The type of adapter used to communicate with external systems
• parameter LOGCONNECTIONS = 0;

Methods

• method OnProcessInput(pMsgIn As Ens.StringContainer, Output pMsgOut As Ens.StringContainer) as %Status
Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).
• classmethod isConfigRunning(pConfigName="") as %String


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