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

class %IO.Socket extends %IO.DeviceStream, %IO.IParts.SocketIO, %IO.SocketCommon

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3


Summary

Properties
AtEnd CharEncoding DefaultFlushOnWrite DisconnectHandler
Host InputBufferSize IsCharacter IsOpen
IsSingleByte KeepAliveInterval LineTerminator LocalInterface
Name OutputBufferSize Port Remote
SSLConfig TCPReceiveBuffer TCPSendBuffer TranslationTable

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
Attach AttachNew CharEncodingSet Close
CopyFrom CopyReplace CopyReplaceArray DefaultFlushOnWriteGet
Flush GetCharEncodingTable GetDeviceLineTerminator GetDeviceTranslationTable
GetLocalInterfaces GetLocaleDefaultTable GetTableCharEncoding InputFromDevice
IsCharacterGet IsLocaleUnicode IsTableSingleByte Open
OutputToDevice Read ReadAny ReadLine
ReadUntil ReadUntilArray SetCharEncodingTable SetDeviceLineTerminator
SetDeviceTranslationTable SetTranslationTable TranslationTableSet Write
WriteLine


Properties

• property Host as %String(MAXLEN=500);

Methods

• method Close(Output pSC As %Status, pIntentional As %Boolean = 1, pSCReason As %Status = $$$OK) as %Boolean
Disconnect and close the current connection
• method Open(pHost As %String = "", pPort As %String = "", ByRef pTimeout As %Numeric = -1, Output pSC As %Status) as %Boolean
Establish a TCP connection to the given host computer on the given port number, if possible within pTimeout.

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