# ws::WebSocket

<a id="websocket"></a>

# WebSocket

```cpp
#include <icy/http/websocket.h>

class WebSocket
```

[Defined in src/http/include/icy/http/websocket.h:366](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L366)

> **Inherits:** [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter)

Standalone [WebSocket](#websocket) class.

## List of all members

| Name | Kind | Owner |
|------|------|-------|
| [`WebSocket`](#websocket-1) | `function` | Declared here |
| [`~WebSocket`](#websocket-2) | `function` | Declared here |
| [`request`](#request-13) | `function` | Declared here |
| [`response`](#response-11) | `function` | Declared here |
| [`_request`](#_request-3) | `variable` | Declared here |
| [`_response`](#_response-3) | `variable` | Declared here |
| [`Vec`](#vec-4) | `typedef` | Declared here |
| [`WebSocketFramer`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketframer) | `friend` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`socket`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#socket-7) | `variable` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter-1) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`send`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#send-15) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`send`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#send-16) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendowned-12) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendowned-13) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`shutdown`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#shutdown-10) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`sendClientRequest`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendclientrequest) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`handleClientResponse`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#handleclientresponse) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`handleServerRequest`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#handleserverrequest) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`onHandshakeComplete`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onhandshakecomplete-1) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`framer`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#framer) | `variable` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`_request`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#_request-4) | `variable` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`_response`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#_response-4) | `variable` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`_closeState`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#_closestate) | `variable` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`~WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter-2) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`sendControlFrame`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendcontrolframe) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`resetFrameState`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#resetframestate) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`onSocketConnect`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onsocketconnect-4) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`onSocketRecv`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onsocketrecv-6) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`onSocketClose`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onsocketclose-4) | `function` | Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) |
| [`Connect`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#connect-4) | `variable` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`Recv`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#recv) | `variable` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`Error`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#error-13) | `variable` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`Close`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#close-20) | `variable` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`impl`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#impl) | `variable` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter-1) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter-2) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`~SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter-3) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`addReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#addreceiver-1) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`removeReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#removereceiver-1) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`swap`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#swap-11) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`as`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#as) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`operator->`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#operator-180) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`onSocketConnect`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketconnect-1) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`onSocketRecv`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketrecv-2) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`onSocketError`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketerror-1) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`onSocketClose`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketclose-1) | `function` | Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) |
| [`priority`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#priority-3) | `variable` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter-1) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`~SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter-2) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`send`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#send-1) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`send`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#send-2) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendowned-2) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendowned-3) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`sendPacket`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendpacket) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`sendPacket`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendpacket-1) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`sendPacket`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendpacket-2) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`setSender`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#setsender) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`sender`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sender) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`addReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#addreceiver) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`removeReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#removereceiver) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`hasReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#hasreceiver) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`receivers`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#receivers) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`onSocketConnect`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketconnect) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`onSocketRecv`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketrecv-1) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`onSocketError`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketerror) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`onSocketClose`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketclose) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`_sender`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_sender) | `variable` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`_receivers`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_receivers) | `variable` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`_dirty`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_dirty) | `variable` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`_dispatchDepth`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_dispatchdepth) | `variable` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |
| [`cleanupReceivers`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#cleanupreceivers) | `function` | Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) |

## Inherited from [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter)

| Kind | Name | Description |
|------|------|-------------|
| `friend` | [`WebSocketFramer`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketframer)  |  |
| `variable` | [`socket`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#socket-7)  | Pointer to the underlying socket. Sent data will be proxied to this socket. |
| `function` | [`WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter-1)  | Creates a [WebSocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter) using the given socket, mode and HTTP message objects. |
| `function` | [`send`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#send-15) `virtual` `override` | Frames and sends data to the peer's address. |
| `function` | [`send`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#send-16) `virtual` `override` | Frames and sends data to a specific peer address (for UDP-backed sockets). |
| `function` | [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendowned-12) `virtual` `override` | Sends an owned payload buffer to the connected peer. |
| `function` | [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendowned-13) `virtual` `override` |  |
| `function` | [`shutdown`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#shutdown-10) `virtual` | Sends a [WebSocket](#websocket) CLOSE frame with the given status code and message, then closes the underlying socket. |
| `function` | [`sendClientRequest`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendclientrequest) `virtual` | [Client](https://auscaster.com/icey/docs/api-reference/icy-http-Client.md#client) side. |
| `function` | [`handleClientResponse`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#handleclientresponse) `virtual` | Parses the server's HTTP upgrade response and completes the handshake. Any data remaining in the buffer after the HTTP response is re-fed as [WebSocket](#websocket) frames. |
| `function` | [`handleServerRequest`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#handleserverrequest) `virtual` | [Server](https://auscaster.com/icey/docs/api-reference/icy-http-Server.md#server) side. |
| `function` | [`onHandshakeComplete`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onhandshakecomplete-1) `virtual` | Called when the [WebSocket](#websocket) handshake completes. Emits the connect event to downstream handlers. |
| `variable` | [`framer`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#framer)  |  |
| `variable` | [`_request`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#_request-4)  |  |
| `variable` | [`_response`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#_response-4)  |  |
| `variable` | [`_closeState`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#_closestate)  |  |
| `function` | [`~WebSocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#websocketadapter-2) `virtual` |  |
| `function` | [`sendControlFrame`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#sendcontrolframe)  |  |
| `function` | [`resetFrameState`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#resetframestate)  |  |
| `function` | [`onSocketConnect`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onsocketconnect-4) `virtual` `override` | Called by the socket on connect; initiates the client handshake. |
| `function` | [`onSocketRecv`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onsocketrecv-6) `virtual` `override` | Called by the socket on each received buffer; handles handshake or frame parsing depending on state. |
| `function` | [`onSocketClose`](https://auscaster.com/icey/docs/api-reference/icy-http-ws-WebSocketAdapter.md#onsocketclose-4) `virtual` `override` | Called by the socket on close; resets framer state. |

## Inherited from [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter)

| Kind | Name | Description |
|------|------|-------------|
| `variable` | [`Connect`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#connect-4)  | Signals that the socket is connected. |
| `variable` | [`Recv`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#recv)  | Signals when data is received by the socket. |
| `variable` | [`Error`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#error-13)  | Signals that the socket is closed in error. This signal will be sent just before the Closed signal. |
| `variable` | [`Close`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#close-20)  | Signals that the underlying socket is closed. |
| `variable` | [`impl`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#impl)  | Pointer to the underlying socket. Sent data will be proxied to this socket. |
| `function` | [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter-1)  | Creates the [SocketEmitter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter) and optionally attaches it to a socket. If `socket` is provided, this emitter registers itself as a receiver. |
| `function` | [`SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter-2)  | Copy constructor; copies all signal connections and attaches to the same socket. |
| `function` | [`~SocketEmitter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#socketemitter-3) `virtual` `noexcept` | Destroys the [SocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter). |
| `function` | [`addReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#addreceiver-1) `virtual` `override` | Attaches a [SocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) as a receiver; wires it to all four socket signals. |
| `function` | [`removeReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#removereceiver-1) `virtual` `override` | Detaches a [SocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) from all four socket signals. |
| `function` | [`swap`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#swap-11) `virtual` | Replaces the underlying socket with `socket`. |
| `function` | [`as`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#as) `inline` | Returns the underlying socket cast to type T, or nullptr if the cast fails. |
| `function` | [`operator->`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#operator-180) `const` `inline` | Returns a raw pointer to the underlying socket for direct method access. Follows shared_ptr semantics; the caller must not delete the returned pointer. |
| `function` | [`onSocketConnect`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketconnect-1) `virtual` `override` | Forwards the connect event to chained adapters, then fires the Connect signal. |
| `function` | [`onSocketRecv`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketrecv-2) `virtual` `override` | Forwards the recv event to chained adapters, then fires the Recv signal. |
| `function` | [`onSocketError`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketerror-1) `virtual` `override` | Forwards the error event to chained adapters, then fires the [Error](https://auscaster.com/icey/docs/api-reference/icy-Error.md#error) signal. |
| `function` | [`onSocketClose`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketEmitter.md#onsocketclose-1) `virtual` `override` | Forwards the close event to chained adapters, then fires the Close signal. |

## Inherited from [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter)

| Kind | Name | Description |
|------|------|-------------|
| `variable` | [`priority`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#priority-3)  | The priority of this adapter for STL sort operations. |
| `function` | [`SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter-1)  | Creates the [SocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter). |
| `function` | [`~SocketAdapter`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter-2) `virtual` `noexcept` | Destroys the [SocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter). |
| `function` | [`send`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#send-1) `virtual` | Sends the given data buffer to the connected peer. Returns the number of bytes sent or -1 on error. No exception will be thrown. For TCP sockets the given peer address must match the connected peer address. |
| `function` | [`send`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#send-2) `virtual` |  |
| `function` | [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendowned-2) `virtual` | Sends an owned payload buffer to the connected peer. |
| `function` | [`sendOwned`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendowned-3) `virtual` |  |
| `function` | [`sendPacket`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendpacket) `virtual` | Sends the given packet to the connected peer. Returns the number of bytes sent or -1 on error. No exception will be thrown. For TCP sockets the given peer address must match the connected peer address. |
| `function` | [`sendPacket`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendpacket-1) `virtual` |  |
| `function` | [`sendPacket`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sendpacket-2) `virtual` | Sends the given packet to the connected peer. This method provides delegate compatibility, and unlike other send methods throws an exception if the underlying socket is closed. |
| `function` | [`setSender`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#setsender) `virtual` | Sets the pointer to the outgoing data adapter. Send methods proxy data to this adapter by default. |
| `function` | [`sender`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#sender)  | Returns the output [SocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) pointer. |
| `function` | [`addReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#addreceiver) `virtual` | Sets the pointer to the incoming data adapter. Events proxy data to this adapter by default. |
| `function` | [`removeReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#removereceiver) `virtual` | Remove the given receiver. |
| `function` | [`hasReceiver`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#hasreceiver) `virtual` | Returns true if the given receiver is connected. |
| `function` | [`receivers`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#receivers)  | Returns all currently registered input [SocketAdapter](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#socketadapter) pointers. Dead (removed) entries are excluded from the returned list. |
| `function` | [`onSocketConnect`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketconnect) `virtual` | Called when the socket establishes a connection. Forwards the event to all registered receivers in priority order. Override to intercept before the application sees the event. |
| `function` | [`onSocketRecv`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketrecv-1) `virtual` | Called when data is received from the socket. Forwards the event to all registered receivers in priority order. |
| `function` | [`onSocketError`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketerror) `virtual` | Called when the socket encounters an error. Forwards the event to all registered receivers in priority order. |
| `function` | [`onSocketClose`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#onsocketclose) `virtual` | Called when the socket is closed. Forwards the event to all registered receivers in priority order. |
| `variable` | [`_sender`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_sender)  |  |
| `variable` | [`_receivers`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_receivers)  |  |
| `variable` | [`_dirty`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_dirty)  |  |
| `variable` | [`_dispatchDepth`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#_dispatchdepth)  |  |
| `function` | [`cleanupReceivers`](https://auscaster.com/icey/docs/api-reference/icy-net-SocketAdapter.md#cleanupreceivers) `virtual` |  |

## Public Methods

| Return | Name | Description |
|--------|------|-------------|
|  | [`WebSocket`](#websocket-1)  | Creates the [WebSocket](#websocket) with the given Socket. The Socket should be a TCPSocket or a SSLSocket, depending on the protocol used (ws or wss). |
|  | [`~WebSocket`](#websocket-2) `virtual` |  |
| [`http::Request`](https://auscaster.com/icey/docs/api-reference/icy-http-Request.md#request-6) & | [`request`](#request-13)  | Returns the HTTP request used during the [WebSocket](#websocket) handshake. |
| [`http::Response`](https://auscaster.com/icey/docs/api-reference/icy-http-Response.md#response-3) & | [`response`](#response-11)  | Returns the HTTP response received during the [WebSocket](#websocket) handshake. |

---

<a id="websocket-1"></a>

### WebSocket

```cpp
WebSocket(const net::Socket::Ptr & socket)
```

[Defined in src/http/include/icy/http/websocket.h:374](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L374)

Creates the [WebSocket](#websocket) with the given Socket. The Socket should be a TCPSocket or a SSLSocket, depending on the protocol used (ws or wss).

---

<a id="websocket-2"></a>

### ~WebSocket

`virtual`

```cpp
virtual ~WebSocket()
```

[Defined in src/http/include/icy/http/websocket.h:376](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L376)

---

<a id="request-13"></a>

### request

```cpp
http::Request & request()
```

[Defined in src/http/include/icy/http/websocket.h:379](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L379)

Returns the HTTP request used during the [WebSocket](#websocket) handshake.

---

<a id="response-11"></a>

### response

```cpp
http::Response & response()
```

[Defined in src/http/include/icy/http/websocket.h:382](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L382)

Returns the HTTP response received during the [WebSocket](#websocket) handshake.

## Protected Attributes

| Return | Name | Description |
|--------|------|-------------|
| [`http::Request`](https://auscaster.com/icey/docs/api-reference/icy-http-Request.md#request-6) | [`_request`](#_request-3)  |  |
| [`http::Response`](https://auscaster.com/icey/docs/api-reference/icy-http-Response.md#response-3) | [`_response`](#_response-3)  |  |

---

<a id="_request-3"></a>

### _request

```cpp
http::Request _request
```

Type: [`http::Request`](https://auscaster.com/icey/docs/api-reference/icy-http-Request.md#request-6)

[Defined in src/http/include/icy/http/websocket.h:385](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L385)

---

<a id="_response-3"></a>

### _response

```cpp
http::Response _response
```

Type: [`http::Response`](https://auscaster.com/icey/docs/api-reference/icy-http-Response.md#response-3)

[Defined in src/http/include/icy/http/websocket.h:386](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L386)

## Public Types

| Name | Description |
|------|-------------|
| [`Vec`](#vec-4)  |  |

---

<a id="vec-4"></a>

### Vec

```cpp
using Vec = std::vector< WebSocket >
```

Type: std::vector< [`WebSocket`](#websocket) >

[Defined in src/http/include/icy/http/websocket.h:369](https://github.com/auscaster/icey/blob/main/src/http/include/icy/http/websocket.h#L369)