|
IRISLIB database
|
|
|
IRISLIB database
|
|
Represents a sent/received frame in a WebSocket connection. More...
Public Member Functions | |
| _.Library.String | Mask (_.Library.String pString) |
| Masks the input string by XOR-ing 4-byte chunks with the masking key. | |
| Read (_.Library.Integer pTimeout) | |
| Translates bytes read from the TCP device into a frame. | |
| Write () | |
| Translates the frame into the wire format and writes it to the TCP device. | |
 Public Member Functions inherited from RegisteredObject | |
| _.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
| This callback method is invoked when the current object is added to the SaveSet,. More... | |
| _.Library.Status | OnClose () |
| This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
| _.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
| This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
| _.Library.Status | OnNew () |
| This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
| _.Library.Status | OnValidateObject () |
| This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
Public Attributes | |
| Fin | |
| More... | |
| HasMessage | |
| Set to false if <method>Read</method> times out rather than receiving a message. More... | |
| Masked | |
| Set to 1 if the payload was received masked. More... | |
| MaskingKey | |
| 4-byte masking key (if <property>Masked</property> is true) More... | |
| Opcode | |
| Valid values (macros in HSMOD.WebSocket.INC) are: More... | |
| PayloadData | |
| Unmasked binary/character data received or to send -. More... | |
| PayloadLength | |
| The length of payload data. More... | |
| RSV1 | |
| Reserved - always 0. More... | |
| RSV2 | |
| Reserved - always 0. More... | |
| RSV3 | |
| Reserved - always 0. More... | |
Private Member Functions | |
| _.Library.String | __ReadBytes (_.Library.Integer pLength, _.Library.Integer pTimeout) |
| Reads in a specified number of bytes from the TCP device. | |
| __WriteData (_.Stream.Object pData) | |
| Writes a stream out to the TCP device. | |
Private Attributes | |
| __Device | |
| Device from which to read (for reads) or write (for writes) More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from RegisteredObject | |
| CAPTION = None | |
| Optional name used by the Form Wizard for a class when generating forms. More... | |
| JAVATYPE = None | |
| The Java type to be used when exported. | |
| PROPERTYVALIDATION = None | |
| This parameter controls the default validation behavior for the object. More... | |
Represents a sent/received frame in a WebSocket connection.
This class is internal to the module and should not be used directly.
|
private |
Device from which to read (for reads) or write (for writes)
| Fin |
| HasMessage |
Set to false if <method>Read</method> times out rather than receiving a message.
| Masked |
Set to 1 if the payload was received masked.
Always set to 1 in send
| MaskingKey |
4-byte masking key (if <property>Masked</property> is true)
If not provided prior to send, will be generated randomly
| Opcode |
Valid values (macros in HSMOD.WebSocket.INC) are:
$$$WebSocketOpContinuation 0 $$$WebSocketOpTextFrame 1 $$$WebSocketOpBinaryFrame 2 $$$WebSocketOpClose 8 $$$WebSocketOpPing 9 $$$WebSocketOpPong 10
| PayloadData |
Unmasked binary/character data received or to send -.
on write, this is masked before sending; on read, it is unmasked automatically.
| PayloadLength |
The length of payload data.
| RSV1 |
Reserved - always 0.
| RSV2 |
Reserved - always 0.
| RSV3 |
Reserved - always 0.
1.9.1