For information on converting to InterSystems IRIS,
see the InterSystems IRIS Adoption Guide
and the InterSystems IRIS In-Place Conversion Guide,
both available on the WRC Distributions page (login required).
Inherited description: Specifies if we wish to turn off charset conversion for this page. Normally CSP uses
the tables built into Cache to convert between different charset's, however if you
do not have a charset available you may wish to turn this off to avoid getting the
error page saying that this charset is not installed. Then the data will be output
and read in using RAW mode. This can be overridden using the <CSP:CONTENT NOCHARSETCONVERT=1>
tag, or by setting the %response.NoCharSetConvert property in the
parameter UseSession = 1;
Inherited description: This parameter controls the CSP session support. By default CSP will use a persistent session
which holds a license until the session is ended or times out. If you override this then this
CSP page will use a transient session which is never persisted.
Properties (Including Private)
property AtEnd as %Boolean [ InitialExpression = 1 ];
The AtEnd property is set to true (1) when, during a read,
the WebSocket server has reached the end of the current data frame.
property BinaryData as %Boolean [ InitialExpression = 0 ];
This property determines whether the data streams transmitted between the client and server should be treated as binary.
The default setting is to treat the incoming and outgoing data as UTF-8 encoded text.
property SharedConnection as %Boolean [ InitialExpression = 0 ];
This property determines whether the communication between the client and WebSocket server should be over a dedicated Gateway
conection or over a pool of shared connections. It may be set to one of the following:
SharedConnection=0 - The WebSocket server communicates with the client via a dedicated Gateway connection. In this mode of operation the hosting connection is effectively 'private' to the application session.
SharedConnection=1 - The WebSocket server communicates asynchronously with the client via a fixed number of shared Gateway connections.
Event handler for the ClientMessage event: this method is only relevant to
WebSockets operating in Asynchronous mode. In other words WebSockets for which
the SharedConnection flag is set.
If OnClientMessage() successfully processes the client message it
must return with 1.
Reads up to len characters from the client.
If the call is successful the status (sc) will be returned as $$$OK, otherwise an error code of $$$CSPWebSocketTimeout
indicates a timeout and $$$CSPWebSocketClosed indicates that the client has terminated the WebSocket.
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.
A WebSocket operating asynchronously (SharedConnection=1) can exit this method
(using Quit) and subsequently open the WebSocket using the OpenServer() method.