Made accessor methods const; made serverName parameter const in QWebSocket

[contrib/qtwebsockets.git] / src / qwebsocketserver.h

diff --git a/src/qwebsocketserver.h b/src/qwebsocketserver.h
index 05f93cf..2ad3d62 100644 (file)
--- a/src/qwebsocketserver.h
+++ b/src/qwebsocketserver.h
@@ -1,8 +1,21 @@
-/**
- * @file websocketserver.h
- * @author Kurt Pattyn (pattyn.kurt@gmail.com)
- * @brief Defines the WebSocketServer class.
- */
+/*
+QWebSockets implements the WebSocket protocol as defined in RFC 6455.
+Copyright (C) 2013 Kurt Pattyn (pattyn.kurt@gmail.com)
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+*/
 
 #ifndef QWEBSOCKETSERVER_H
 #define QWEBSOCKETSERVER_H
@@ -13,48 +26,65 @@
 #include "qwebsocketsglobal.h"
 #include "qwebsocketprotocol.h"
 
+QT_BEGIN_NAMESPACE
+
 class QWebSocketServerPrivate;
 class QWebSocket;
 
 class Q_WEBSOCKETS_EXPORT QWebSocketServer : public QObject
 {
-       Q_OBJECT
+    Q_OBJECT
 
 public:
-       explicit QWebSocketServer(const QString &serverName, QObject *parent = 0);
-       virtual ~QWebSocketServer();
-
-       void close();
-       QString errorString() const;
-       bool hasPendingConnections() const;
-       bool isListening() const;
-       bool listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0);
-       int maxPendingConnections() const;
-       virtual QWebSocket *nextPendingConnection();
-       QNetworkProxy proxy() const;
-       QHostAddress serverAddress() const;
-       QAbstractSocket::SocketError serverError() const;
-       quint16 serverPort() const;
-       void setMaxPendingConnections(int numConnections);
-       void setProxy(const QNetworkProxy &networkProxy);
-       bool setSocketDescriptor(int socketDescriptor);
-       int socketDescriptor() const;
-       bool waitForNewConnection(int msec = 0, bool *timedOut = 0);
-
-       QList<QWebSocketProtocol::Version> supportedVersions() const;
-       QList<QString> supportedProtocols() const;
-       QList<QString> supportedExtensions() const;
+    explicit QWebSocketServer(const QString &serverName, QObject *parent = 0);
+    virtual ~QWebSocketServer();
+
+    bool listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0);
+    void close();
+
+    bool isListening() const;
+
+    void setMaxPendingConnections(int numConnections);
+    int maxPendingConnections() const;
+
+    quint16 serverPort() const;
+    QHostAddress serverAddress() const;
+
+    bool setSocketDescriptor(int socketDescriptor);
+    int socketDescriptor() const;
+
+    bool waitForNewConnection(int msec = 0, bool *timedOut = 0);
+    bool hasPendingConnections() const;
+    virtual QWebSocket *nextPendingConnection();
+
+    QAbstractSocket::SocketError serverError() const;
+    QString errorString() const;
+
+    void pauseAccepting();
+    void resumeAccepting();
+
+#ifndef QT_NO_NETWORKPROXY
+    void setProxy(const QNetworkProxy &networkProxy);
+    QNetworkProxy proxy() const;
+#endif
+
+    QList<QWebSocketProtocol::Version> supportedVersions() const;
+    QList<QString> supportedProtocols() const;
+    QList<QString> supportedExtensions() const;
 
 protected:
-       virtual bool isOriginAllowed(const QString &origin) const;
+    virtual bool isOriginAllowed(const QString &origin) const;
 
 Q_SIGNALS:
-       void newConnection();
+    void acceptError(QAbstractSocket::SocketError socketError);
+    void newConnection();
 
 private:
-       Q_DISABLE_COPY(QWebSocketServer)
-       QWebSocketServerPrivate * const d_ptr;
-       friend class QWebSocketServerPrivate;
+    Q_DISABLE_COPY(QWebSocketServer)
+    QWebSocketServerPrivate * const d_ptr;
+    friend class QWebSocketServerPrivate;
 };
 
+QT_END_NAMESPACE
+
 #endif // QWEBSOCKETSERVER_H