Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Atelier] >  [v7] >  [TerminalAgent]
Private  Storage   

class %Atelier.v7.TerminalAgent extends %CSP.WebSocket

This class serves as an agent for terminal I/O.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 11 18


Summary

Properties
AtEnd BinaryData GWClientAddress NoDataFraming
SessionEndOnClose SessionId SharedConnection Trace
WebSocketID

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
ConvertParameter Decrypt Encrypt EndServer
EscapeHTML EscapeURL HyperEventCall HyperEventHead
Include Initialize InitializeServer InsertHiddenField
InsertHiddenFields IsPrivate Link OnClientMessage
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPostServer OnPreHTTP OnPreHyperEvent
OnPreServer OpenServer QuoteJS Read
RewriteURL SendAsyncMessage Server ShowError
StartTimer StopTimer SyntaxColorInput ThrowError
UnescapeHTML UnescapeURL Write


Parameters

• parameter SECURITYRESOURCE = "%Development";
Require development resource

Properties

• property Trace as %Boolean [ InitialExpression = $GET(^IRIS.Temp.Atelier("terminal")) > 0 ];
This holds the TRACE flag

Methods

• method OnPostServer() as %Status
Event handler for the PostServer event: this is invoked after closing the WebSockets Server.
• method OnPreServer() as %Status
Event handler for the PreServer event: this is invoked before starting the WebSockets Server.
• method Server() as %Status
The WebSocket Server. Use the Read and Write methods to receive data from, and send data to, the client. Call the EndServer method to gracefully terminate the WebSocket Server.
• method SyntaxColorInput(pInput As %String, Output pOutput As %String) as %Status
Returns pInput with ANSI escape codes that color the text


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