# Class: ServerWebSocket

## vertx-js/server_web_socket~ ServerWebSocket

#### new ServerWebSocket()

  Represents a server side WebSocket.

  Source:
    - server_web_socket.js, line 34

### 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:
    - server_web_socket.js, line 66

  ##### Returns:

  the binary handler id
  Type
    string

#### close()

  Close the WebSocket.
  Source:
    - server_web_socket.js, line 98

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 317

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 247

  ##### Returns:

  Type
    ServerWebSocket

#### endHandler(endHandler) → {ServerWebSocket}

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 205

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 145

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 331

  ##### Returns:

  Type
    ServerWebSocket

#### handler(handler) → {ServerWebSocket}

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 161

  ##### Returns:

  Type
    ServerWebSocket

#### headers() → {MultiMap}

  Source:
    - server_web_socket.js, line 389

  ##### Returns:

  - the headers in the WebSocket handshake
  - Type
      MultiMap

#### localAddress() → {SocketAddress}

  Source:
    - server_web_socket.js, line 129

  ##### Returns:

  - the local address for this socket
  - Type
      SocketAddress

#### path() → {string}

  Source:
    - server_web_socket.js, line 361

  ##### Returns:

  - the WebSocket handshake path.
  - Type
      string

#### pause() → {ServerWebSocket}

  Source:
    - server_web_socket.js, line 177

  ##### Returns:

  Type
    ServerWebSocket

#### query() → {string}

  Source:
    - server_web_socket.js, line 375

  ##### Returns:

  - the WebSocket handshake query string.
  - Type
      string

#### reject()

  Reject the WebSocket.

  Calling this method from the websocket handler when it is first passed to you gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning a 404 response code.

  You might use this method, if for example you only want to accept WebSockets with a particular path.

  Source:
    - server_web_socket.js, line 411

#### remoteAddress() → {SocketAddress}

  Source:
    - server_web_socket.js, line 112

  ##### Returns:

  - the remote address for this socket
  - Type
      SocketAddress

#### resume() → {ServerWebSocket}

  Source:
    - server_web_socket.js, line 191

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 233

  ##### Returns:

  Type
    ServerWebSocket

#### 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:
    - server_web_socket.js, line 85

  ##### Returns:

  Type
    string

#### uri() → {string}

  Source:
    - server_web_socket.js, line 347

  ##### Returns:

  Type
    string

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 219

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 303

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 289

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 275

  ##### Returns:

  Type
    ServerWebSocket

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

  ##### Parameters:

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

  Source:
    - server_web_socket.js, line 261

  ##### Returns:

  Type
    ServerWebSocket

#### writeQueueFull() → {boolean}

  This will return `true` if there are more bytes in the write queue than the value set using ServerWebSocket#setWriteQueueMaxSize
  Source:
    - server_web_socket.js, line 47

  ##### Returns:

  true if write queue is full
  Type
    boolean