summaryrefslogtreecommitdiff
path: root/examples/websockets/doc/sslechoclient.qdoc
blob: c6766aaec1cdd631e0c38cbcd3bc215c0836bda0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause

/*!
    \example sslechoclient
    \title Secure WebSocket Echo Client
    \examplecategory {Networking}
    \ingroup qtwebsockets-examples
    \brief A simple client application using secure WebSockets (wss).

    The Secure WebSocket Echo Client example shows how to use the
    \l {Qt WebSockets}{WebSocket} class to implement an echo client over
    a secure connection (wss). It connects to a server and sends a message,
    and when it receives a message back, it prints it out and exits. SSL
    support is required for this example to work.

    This example connects by default to localhost at port 1234 using a secure
    connection. It trusts the certificates signed by the CA certificates
    configured in the SSL backend, and in addition trusts the certificate
    used by \l {Secure WebSocket Echo Server}.

    \image echoclient-console-example.webp Secure WebSocket Echo Console Client

    \sa {WebSocket Echo Client}, {Secure WebSocket Echo Server}
*/