Qt Bluetooth: Modularized documentation

-moved documentation to src/bluetooth/doc
-added a qdocconf file for Qt Bluetooth
-fixed relative paths for snippets
-moved examples to examples/bluetooth

Change-Id: Id41bac50dca628400568d191f1c3ccfbaac790a1
Reviewed-by: Alex <ablasche@gmail.com>

1 files changed, 182 insertions, 0 deletions

diff --git a/examples/bluetooth/btchat/chatserver.cpp b/examples/bluetooth/btchat/chatserver.cpp
new file mode 100644
index 00000000..545a0b03
--- /dev/null
+++ b/examples/bluetooth/btchat/chatserver.cpp
@@ -0,0 +1,182 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtBluetooth module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
+**     of its contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "chatserver.h"
+
+#include <qrfcommserver.h>
+#include <qbluetoothsocket.h>
+
+//! [Service UUID]
+static const QLatin1String serviceUuid("e8e10f95-1a70-4b27-9ccf-02010264e9c8");
+//! [Service UUID]
+
+ChatServer::ChatServer(QObject *parent)
+:   QObject(parent), rfcommServer(0)
+{
+}
+
+ChatServer::~ChatServer()
+{
+    stopServer();
+}
+
+void ChatServer::startServer()
+{
+    if (rfcommServer)
+        return;
+
+    //! [Create the server]
+    rfcommServer = new QRfcommServer(this);
+    connect(rfcommServer, SIGNAL(newConnection()), this, SLOT(clientConnected()));
+    rfcommServer->listen();
+    //! [Create the server]
+
+    serviceInfo.setAttribute(QBluetoothServiceInfo::ServiceRecordHandle, (uint)0x00010010);
+
+    //! [Class Uuuid must contain at least 1 entry]
+    QBluetoothServiceInfo::Sequence classId;
+    classId << QVariant::fromValue(QBluetoothUuid(serviceUuid));
+    serviceInfo.setAttribute(QBluetoothServiceInfo::ServiceClassIds, classId);
+    //! [Class Uuuid must contain at least 1 entry]
+
+
+    //! [Service name, description and provider]
+    serviceInfo.setAttribute(QBluetoothServiceInfo::ServiceName, tr("Bt Chat Server"));
+    serviceInfo.setAttribute(QBluetoothServiceInfo::ServiceDescription,
+                             tr("Example bluetooth chat server"));
+    serviceInfo.setAttribute(QBluetoothServiceInfo::ServiceProvider, tr("Nokia, QtDF"));
+    //! [Service name, description and provider]
+
+    //! [Service UUID set]
+    serviceInfo.setServiceUuid(QBluetoothUuid(serviceUuid));
+    //! [Service UUID set]
+
+    //! [Service Discoverability]
+    serviceInfo.setAttribute(QBluetoothServiceInfo::BrowseGroupList,
+                             QBluetoothUuid(QBluetoothUuid::PublicBrowseGroup));
+    //! [Service Discoverability]
+
+    //! [Protocol descriptor list]
+    QBluetoothServiceInfo::Sequence protocolDescriptorList;
+    QBluetoothServiceInfo::Sequence protocol;
+    protocol << QVariant::fromValue(QBluetoothUuid(QBluetoothUuid::L2cap));
+    protocolDescriptorList.append(QVariant::fromValue(protocol));
+    protocol.clear();
+    protocol << QVariant::fromValue(QBluetoothUuid(QBluetoothUuid::Rfcomm))
+             << QVariant::fromValue(quint8(rfcommServer->serverPort()));
+    protocolDescriptorList.append(QVariant::fromValue(protocol));
+    serviceInfo.setAttribute(QBluetoothServiceInfo::ProtocolDescriptorList,
+                             protocolDescriptorList);
+    //! [Protocol descriptor list]
+
+    //! [Register service]
+    serviceInfo.registerService();
+    //! [Register service]
+}
+
+//! [stopServer]
+void ChatServer::stopServer()
+{
+    // Unregister service
+    serviceInfo.unregisterService();
+
+    // Close sockets
+    qDeleteAll(clientSockets);
+
+    // Close server
+    delete rfcommServer;
+    rfcommServer = 0;
+}
+//! [stopServer]
+
+//! [sendMessage]
+void ChatServer::sendMessage(const QString &message)
+{
+    QByteArray text = message.toUtf8() + '\n';
+
+    foreach (QBluetoothSocket *socket, clientSockets)
+        socket->write(text);
+}
+//! [sendMessage]
+
+//! [clientConnected]
+void ChatServer::clientConnected()
+{
+    QBluetoothSocket *socket = rfcommServer->nextPendingConnection();
+    if (!socket)
+        return;
+
+    connect(socket, SIGNAL(readyRead()), this, SLOT(readSocket()));
+    connect(socket, SIGNAL(disconnected()), this, SLOT(clientDisconnected()));
+    clientSockets.append(socket);
+
+    emit clientConnected(socket->peerName());
+}
+//! [clientConnected]
+
+//! [clientDisconnected]
+void ChatServer::clientDisconnected()
+{
+    QBluetoothSocket *socket = qobject_cast<QBluetoothSocket *>(sender());
+    if (!socket)
+        return;
+
+    emit clientDisconnected(socket->peerName());
+
+    clientSockets.removeOne(socket);
+
+    socket->deleteLater();
+}
+//! [clientDisconnected]
+
+//! [readSocket]
+void ChatServer::readSocket()
+{
+    QBluetoothSocket *socket = qobject_cast<QBluetoothSocket *>(sender());
+    if (!socket)
+        return;
+
+    while (socket->canReadLine()) {
+        QByteArray line = socket->readLine().trimmed();
+        emit messageReceived(socket->peerName(),
+                             QString::fromUtf8(line.constData(), line.length()));
+    }
+}
+//! [readSocket]