# Class: WebSocket

## vertx-js/web_socket~ WebSocket

#### new WebSocket()

Represents a client-side WebSocket.

Source:
  - vertx-js/web_socket.js, line 33

### Methods

#### binaryHandlerID() → {string}

When a `Websocket` is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.

Given this ID, a different event loop can send a binary frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

Source:
  - vertx-js/web_socket.js, line 80

##### Returns:

the binary handler id

Type
  string

#### binaryMessageHandler(handler) → {WebSocketBase}

Set a binary message handler on the connection. This handler serves a similar purpose to WebSocket#handler except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using WebSocketFrame#isFinal to find the boundaries).

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function | the handler

Source:
  - vertx-js/web_socket.js, line 133

##### Returns:

a reference to this, so the API can be used fluently

Type
  WebSocketBase

#### close()

Close the WebSocket.

Source:
  - vertx-js/web_socket.js, line 149

#### closeHandler(handler) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/web_socket.js, line 393

##### Returns:

Type
  WebSocket

#### drainHandler(handler) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/web_socket.js, line 309

##### Returns:

Type
  WebSocket

#### end(t)

Same as WebSocketBase#end but writes some data to the stream before ending.

##### Parameters:

Name | Type | Description
--- | --- | ---
`t` | Buffer |

Source:
  - vertx-js/web_socket.js, line 45

#### endHandler(endHandler) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`endHandler` | function |

Source:
  - vertx-js/web_socket.js, line 267

##### Returns:

Type
  WebSocket

#### exceptionHandler(handler) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/web_socket.js, line 207

##### Returns:

Type
  WebSocket

#### frameHandler(handler) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/web_socket.js, line 407

##### Returns:

Type
  WebSocket

#### handler(handler) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function |

Source:
  - vertx-js/web_socket.js, line 223

##### Returns:

Type
  WebSocket

#### isSsl() → {boolean}

Source:
  - vertx-js/web_socket.js, line 194

##### Returns:

true if this HttpConnection is encrypted via SSL/TLS.

Type
  boolean

#### localAddress() → {SocketAddress}

Source:
  - vertx-js/web_socket.js, line 178

##### Returns:

the local address for this socket

Type
  SocketAddress

#### pause() → {WebSocket}

Source:
  - vertx-js/web_socket.js, line 239

##### Returns:

Type
  WebSocket

#### remoteAddress() → {SocketAddress}

Source:
  - vertx-js/web_socket.js, line 162

##### Returns:

the remote address for this socket

Type
  SocketAddress

#### resume() → {WebSocket}

Source:
  - vertx-js/web_socket.js, line 253

##### Returns:

Type
  WebSocket

#### setWriteQueueMaxSize(maxSize) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`maxSize` | number |

Source:
  - vertx-js/web_socket.js, line 295

##### Returns:

Type
  WebSocket

#### textHandlerID() → {string}

When a `Websocket` is created it automatically registers an event handler with the eventbus, the ID of that handler is given by `textHandlerID`.

Given this ID, a different event loop can send a text frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

Source:
  - vertx-js/web_socket.js, line 99

##### Returns:

Type
  string

#### textMessageHandler(handler) → {WebSocketBase}

Set a text message handler on the connection. This handler will be called similar to the , but the buffer will be converted to a String first

##### Parameters:

Name | Type | Description
--- | --- | ---
`handler` | function | the handler

Source:
  - vertx-js/web_socket.js, line 114

##### Returns:

a reference to this, so the API can be used fluently

Type
  WebSocketBase

#### write(data) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`data` | Buffer |

Source:
  - vertx-js/web_socket.js, line 281

##### Returns:

Type
  WebSocket

#### writeBinaryMessage(data) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`data` | Buffer |

Source:
  - vertx-js/web_socket.js, line 365

##### Returns:

Type
  WebSocket

#### writeFinalBinaryFrame(data) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`data` | Buffer |

Source:
  - vertx-js/web_socket.js, line 351

##### Returns:

Type
  WebSocket

#### writeFinalTextFrame(text) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`text` | string |

Source:
  - vertx-js/web_socket.js, line 337

##### Returns:

Type
  WebSocket

#### writeFrame(frame) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`frame` | WebSocketFrame |

Source:
  - vertx-js/web_socket.js, line 323

##### Returns:

Type
  WebSocket

#### writeQueueFull() → {boolean}

This will return `true` if there are more bytes in the write queue than the value set using WebSocket#setWriteQueueMaxSize

Source:
  - vertx-js/web_socket.js, line 61

##### Returns:

true if write queue is full

Type
  boolean

#### writeTextMessage(text) → {WebSocket}

##### Parameters:

Name | Type | Description
--- | --- | ---
`text` | string |

Source:
  - vertx-js/web_socket.js, line 379

##### Returns:

Type
  WebSocket