- Qt 6.7
- Qt WebSockets
- QML Types
- WebSocketServer
- Qt 6.7.1 Reference Documentation

# WebSocketServer QML Type

QML interface to QWebSocketServer. More...

Import Statement: | import QtWebSockets 1.7

- List of all members, including inherited members

## Properties

- accept : bool
- errorString : QString
- host : QString
- listen : bool
- name : QString
- port : int
- supportedSubprotocols : QStringList `(since 6.4)`
- url : QUrl

## Signals

- clientConnected(WebSocket webSocket)

## Detailed Description

## Property Documentation

accept : bool

Set to true to accept incoming client connections when the server is listening. When set to false, incoming connections are rejected. By default, connections are accepted.

errorString : QString `[read-only]`

The stringified error message in case an error occurred.

host : QString

The host address of the server. By default, localhost is used.

listen : bool

Set to true when the server should listen to client connections or false otherwise. When set to true, the server will listen on the specified url defined by host and port and, when accept is true, accepts incoming client connections. Otherwise the server is closed. By default, the server is not listening.

name : QString

The name of this server used during the http handshake phase.

port : int

The port this server is listening on. The value must be in the range 0-65535.

By default, a port is chosen automatically.

supportedSubprotocols : QStringList `[since 6.4]`

The list of protocols supported by the server.

This property was introduced in Qt 6.4.

url : QUrl `[read-only]`

Server url that client WebSockets can connect to. The url uses the ws:// scheme and includes the port the server listens to and the host address of the server.

## Signal Documentation

clientConnected(WebSocket webSocket)

This signal is emitted when a client connects to this server. webSocket is the newly created WebSocket.

Note: The corresponding handler is `onClientConnected`.