summaryrefslogtreecommitdiff
path: root/src/websockets/qwebsockethandshakeoptions.cpp
blob: 8dcc3e0a8c4765e41a14fb4008b4af1046dd0377 (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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// Copyright (C) 2022 Menlo Systems GmbH, author Arno Rehn <a.rehn@menlosystems.com>.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include "qwebsockethandshakeoptions_p.h"

QT_BEGIN_NAMESPACE

/*!
    \class QWebSocketHandshakeOptions

    \inmodule QtWebSockets
    \since 6.4
    \brief Collects options for the WebSocket handshake.

    QWebSocketHandshakeOptions collects options that are passed along to the
    WebSocket handshake, such as WebSocket subprotocols and WebSocket
    Extensions.

    At the moment, only WebSocket subprotocols are supported.

    \sa QWebSocket::open()
*/

/*!
    \brief Constructs an empty QWebSocketHandshakeOptions object.
*/
QWebSocketHandshakeOptions::QWebSocketHandshakeOptions()
    : d(new QWebSocketHandshakeOptionsPrivate)
{
}

/*!
    \brief Constructs a QWebSocketHandshakeOptions that is a copy of \a other.
*/
QWebSocketHandshakeOptions::QWebSocketHandshakeOptions(const QWebSocketHandshakeOptions &other)
    : d(other.d)
{
}

/*!
    \fn  QWebSocketHandshakeOptions::QWebSocketHandshakeOptions(QWebSocketHandshakeOptions &&other) noexcept
    \brief Constructs a QWebSocketHandshakeOptions that is moved from \a other.
*/

/*!
    \brief Destroys this object.
*/
QWebSocketHandshakeOptions::~QWebSocketHandshakeOptions()
{
}

/*!
    \fn QWebSocketHandshakeOptions &QWebSocketHandshakeOptions::operator=(QWebSocketHandshakeOptions &&other) noexcept
    \brief Moves \a other to this object.
*/

/*!
    \brief Assigns \a other to this object.
*/
QWebSocketHandshakeOptions &QWebSocketHandshakeOptions::operator=(
        const QWebSocketHandshakeOptions &other)
{
    d = other.d;
    return *this;
}

/*!
    \fn void swap(QWebSocketHandshakeOptions &other) noexcept
    \brief Swaps this object with \a other.
*/

/*!
    \brief Returns the list of WebSocket subprotocols to send along with the
           websocket handshake.
*/
QStringList QWebSocketHandshakeOptions::subprotocols() const
{
    return d->subprotocols;
}

/*!
    \brief Sets the list of WebSocket subprotocols \a protocols to send along
           with the websocket handshake.

    WebSocket subprotocol names may only consist of those US-ASCII characters
    that are in the unreserved group. Invalid protocol names will not be
    included in the handshake.
*/
void QWebSocketHandshakeOptions::setSubprotocols(const QStringList &protocols)
{
    d->subprotocols = protocols;
}

bool QWebSocketHandshakeOptions::equals(const QWebSocketHandshakeOptions &other) const
{
    return *d == *other.d;
}

/*!
    //! friend
    \fn QWebSocketHandshakeOptions::operator==(const QWebSocketHandshakeOptions &lhs, const QWebSocketHandshakeOptions &rhs)
    \fn QWebSocketHandshakeOptions::operator!=(const QWebSocketHandshakeOptions &lhs, const QWebSocketHandshakeOptions &rhs)
    \brief Compares \a lhs for equality with \a rhs.
*/

QT_DEFINE_QSDP_SPECIALIZATION_DTOR(QWebSocketHandshakeOptionsPrivate)

QT_END_NAMESPACE