WebSocketDevice class | QSYS API Reference Guide
Estimated reading time: 2 minutes
Implements a WebDevice using a socket to communicate with a website for its UI services.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object –> WebDevice
Constructors
Name | Description |
---|---|
WebSocketDevice(InteractiveJob) | Initializes a new instance of the WebSocketDevice class for a job. |
WebSocketDevice(InteractiveJob)
Initializes a new instance of the WebSocketDevice class for a job.
WebSocketDevice(InteractiveJob)
Parameters
Type | Parameter name | Description |
---|---|---|
InteractiveJob | job | The job associated with the WebSocketDevice. |
Methods
Signature | Description |
---|---|
close() | Closes the device and the assoiated socket. |
open() | Opens the device. |
read() | Waits for the user to enter new data on the web site. |
RiseAbnormalEnd(String, String) | Marks the device as being in a job that is ending abnormally. |
sendHostResult() | Send the active display file’s host service results and waits for new input. |
SetSocket(Socket) | Sets the socket used to communicate with the website providing the UI services. |
void close()
Closes the device and the assoiated socket.
void close()
void open()
Opens the device.
void open()
void read()
Waits for the user to enter new data on the web site.
void read()
void RiseAbnormalEnd(string abEndMessage, string abEndStack)
Marks the device as being in a job that is ending abnormally.
void RiseAbnormalEnd(string abEndMessage, string abEndStack)
Parameters
Type | Parameter name | Description |
---|---|---|
String | abEndMessage | A message text describing the abnormal termination. |
String | abEndStack | The execution stack at the moment of failure. |
void sendHostResult()
Send the active display file’s host service results and waits for new input.
void sendHostResult()
void SetSocket(Socket socket)
Sets the socket used to communicate with the website providing the UI services.
void SetSocket(Socket socket)
Parameters
Type | Parameter name | Description |
---|---|---|
Socket | socket | The socket used in communications with the website. |