<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmaskgenerator.cpp -->
<title>QMaskGenerator Class | Qt WebSockets 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtwebsockets-index.html">Qt WebSockets</a></td><td ><a href="qtwebsockets-module.html">C++ Classes</a></td><td >QMaskGenerator</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtwebsockets-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QMaskGenerator Class</h1>
<!-- $$$QMaskGenerator-brief -->
<p>The <a href="qmaskgenerator.html">QMaskGenerator</a> class provides an abstract base for custom 32-bit mask generators. <a href="#details">More...</a></p>
<!-- @@@QMaskGenerator -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMaskGenerator></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += websockets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.3</td></tr></table></div><ul>
<li><a href="qmaskgenerator-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmaskgenerator.html#QMaskGenerator">QMaskGenerator</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qmaskgenerator.html#dtor.QMaskGenerator">~QMaskGenerator</a></b>() override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual quint32 </td><td class="memItemRight bottomAlign"><b><a href="qmaskgenerator.html#nextMask">nextMask</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmaskgenerator.html#seed">seed</a></b>() = 0</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QMaskGenerator-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qmaskgenerator.html">QMaskGenerator</a> class provides an abstract base for custom 32-bit mask generators.</p>
<p>The WebSockets specification as outlined in <a href="http://tools.ietf.org/html/rfc6455">RFC 6455</a> requires that all communication from client to server be masked. This is to prevent malicious scripts from attacking badly behaving proxies. For more information about the importance of good masking, see <a href="http://w2spconf.com/2011/papers/websocket.pdf">"Talking to Yourself for Fun and Profit" by Lin-Shung Huang et al</a>. By default <a href="qwebsocket.html">QWebSocket</a> uses the reasonably secure QRandomGenerator::global()->generate() function. The best measure against attacks mentioned in the document above, is to use <a href="qwebsocket.html">QWebSocket</a> over a secure connection (<i>wss://</i>). In general, always be careful to not have 3rd party script access to a <a href="qwebsocket.html">QWebSocket</a> in your application.</p>
</div>
<!-- @@@QMaskGenerator -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMaskGenerator[overload1]$$$QMaskGeneratorQObject* -->
<h3 class="fn" id="QMaskGenerator"><a name="QMaskGenerator"></a>QMaskGenerator::<span class="name">QMaskGenerator</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Creates a new <a href="qmaskgenerator.html">QMaskGenerator</a> object with the given optional QObject <i>parent</i>.</p>
<!-- @@@QMaskGenerator -->
<!-- $$$~QMaskGenerator[overload1]$$$~QMaskGenerator -->
<h3 class="fn" id="dtor.QMaskGenerator"><a name="dtor.QMaskGenerator"></a><code>[override virtual] </code>QMaskGenerator::<span class="name">~QMaskGenerator</span>()</h3>
<p>Destroys the <a href="qmaskgenerator.html">QMaskGenerator</a> object.</p>
<!-- @@@~QMaskGenerator -->
<!-- $$$nextMask[overload1]$$$nextMask -->
<h3 class="fn" id="nextMask"><a name="nextMask"></a><code>[pure virtual] </code><span class="type">quint32</span> QMaskGenerator::<span class="name">nextMask</span>()</h3>
<p>Returns a new random 32-bit mask. The randomness depends on the RNG used to created the mask.</p>
<!-- @@@nextMask -->
<!-- $$$seed[overload1]$$$seed -->
<h3 class="fn" id="seed"><a name="seed"></a><code>[pure virtual] </code><span class="type">bool</span> QMaskGenerator::<span class="name">seed</span>()</h3>
<p>Initializes the <a href="qmaskgenerator.html">QMaskGenerator</a> by seeding the randomizer. When seed() is not called, it depends on the specific implementation of a subclass if a default seed is used or no seed is used at all. Returns <i>true</i> if seeding succeeds, otherwise false.</p>
<!-- @@@seed -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
