# 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

#### close()

Close the WebSocket.

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

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### 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 217

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

#### localAddress() → {SocketAddress}

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

##### Returns:

the local address for this socket

Type
  SocketAddress

#### pause() → {WebSocket}

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

##### Returns:

Type
  WebSocket

#### remoteAddress() → {SocketAddress}

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

##### Returns:

the remote address for this socket

Type
  SocketAddress

#### resume() → {WebSocket}

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### 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

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### Returns:

Type
  WebSocket

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

##### Parameters:

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

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

##### 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