WPILibC++ 2024.3.2
wpi::WebSocketServer Class Reference

Dedicated WebSocket server. More...

#include <wpinet/WebSocketServer.h>

Inheritance diagram for wpi::WebSocketServer:

Classes

struct  ServerOptions
 Server options. More...
 

Public Member Functions

 WebSocketServer (uv::Stream &stream, std::span< const std::string_view > protocols, ServerOptions options, const private_init &)
 Private constructor. More...
 

Static Public Member Functions

static std::shared_ptr< WebSocketServerCreate (uv::Stream &stream, std::span< const std::string_view > protocols={}, const ServerOptions &options={})
 Starts a dedicated WebSocket server on the provided connection. More...
 
static std::shared_ptr< WebSocketServerCreate (uv::Stream &stream, std::initializer_list< std::string_view > protocols, const ServerOptions &options={})
 Starts a dedicated WebSocket server on the provided connection. More...
 

Public Attributes

sig::Signal< std::string_view, WebSocket & > connected
 Connected event. More...
 

Detailed Description

Dedicated WebSocket server.

Constructor & Destructor Documentation

◆ WebSocketServer()

wpi::WebSocketServer::WebSocketServer ( uv::Stream stream,
std::span< const std::string_view protocols,
ServerOptions  options,
const private_init &   
)

Private constructor.

Member Function Documentation

◆ Create() [1/2]

static std::shared_ptr< WebSocketServer > wpi::WebSocketServer::Create ( uv::Stream stream,
std::initializer_list< std::string_view protocols,
const ServerOptions options = {} 
)
inlinestatic

Starts a dedicated WebSocket server on the provided connection.

The connection should be an accepted client stream. This also sets the stream user data to the socket server. A connected event is emitted when the connection is opened.

Parameters
streamConnection stream
protocolsAcceptable subprotocols
optionsHandshake options

◆ Create() [2/2]

static std::shared_ptr< WebSocketServer > wpi::WebSocketServer::Create ( uv::Stream stream,
std::span< const std::string_view protocols = {},
const ServerOptions options = {} 
)
static

Starts a dedicated WebSocket server on the provided connection.

The connection should be an accepted client stream. This also sets the stream user data to the socket server. A connected event is emitted when the connection is opened.

Parameters
streamConnection stream
protocolsAcceptable subprotocols
optionsHandshake options

Member Data Documentation

◆ connected

sig::Signal<std::string_view, WebSocket&> wpi::WebSocketServer::connected

Connected event.

First parameter is the URL, second is the websocket.


The documentation for this class was generated from the following file: