WebSocket.send()
The WebSocket.send() method enqueues the specified data
to be transmitted to the server over the WebSocket connection, increasing the value of
bufferedAmount by the number of bytes needed to contain the data. If the
data can't be sent (for example, because it needs to be buffered but the buffer is
full), the socket is closed automatically.
Syntax
WebSocket.send("Hello server!");Parameters
data- The data to send to the server. It may be one of the following types:
USVString- A text string. The string is added to the buffer in UTF-8 format, and the value
of
bufferedAmountis increased by the number of bytes required to represent the UTF-8 string. ArrayBuffer- You can send the underlying binary data used by a typed array object; its binary
data contents are queued in the buffer, increasing the value of
bufferedAmountby the requisite number of bytes. Blob- Specifying a
Blobenqueues the blob's raw data to be transmitted in a binary frame. The value ofbufferedAmountis increased by the byte size of that raw data. ArrayBufferView- You can send any JavaScript
typed array object as a binary frame; its binary data contents are queued in
the buffer, increasing the value of
bufferedAmountby the requisite number of bytes.
Exceptions thrown
INVALID_STATE_ERR- The connection is not currently
OPEN. SYNTAX_ERR- The data is a string that has unpaired surrogates.
Note: Gecko's implementation of the send() method
differs somewhat from the specification in Gecko 6.0; Gecko returns a
boolean indicating whether or not the connection is still open (and, by
extension, that the data was successfully queued or transmitted); this is corrected in
Gecko 8.0.
As of Gecko 11.0, support for ArrayBuffer is implemented but not
Blob data types.
Specifications
| Specification | Status | Comment |
|---|---|---|
| HTML Living Standard The definition of 'WebSocket: send' in that specification. |
Living Standard | Initial definition |
Browser compatibility
BCD tables only load in the browser