/usr/include/QHttpEngine/qobjecthandler.h is in libqhttpengine-dev 0.1.0+dfsg1-1+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* Copyright (c) 2015 Nathan Osman
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#ifndef QHTTPENGINE_QOBJECTHANDLER_H
#define QHTTPENGINE_QOBJECTHANDLER_H
#include "qhttpengine.h"
#include "qhttphandler.h"
class QHTTPENGINE_EXPORT QObjectHandlerPrivate;
/**
* @brief Handler for invoking slots
* @headerfile qobjecthandler.h QHttpEngine/QObjectHandler
*
* This handler enables incoming requests to invoke a matching slot in a
* QObject-derived class. The request body is expected to contain parameters
* encoded as a JSON object. This object is then passed to the slot as a
* single QVariantMap argument. The slot should return a QVariantMap
* containing the response.
*
* To use this class, it must be subclassed and one or more slots must be
* created. The name of the slot will be used to determine the path. For
* example, the following handler consists of a single method that can be
* invoked by using the `/doSomething` path.
*
* @code
* class TestHandler : public QObjectHandler
* {
* Q_OBJECT
* private slots:
* QVariantMap doSomething(QVariantMap params);
* };
* @endcode
*
* The request body must contain valid JSON which will be decoded and passed
* to the doSomething() slot as a QVariantMap. The slot should return a
* QVariantMap which will then be encoded as JSON and written to the socket as
* the response body.
*/
class QHTTPENGINE_EXPORT QObjectHandler : public QHttpHandler
{
Q_OBJECT
public:
/**
* @brief Create a new QObject handler
*/
explicit QObjectHandler(QObject *parent = 0);
protected:
/**
* @brief Reimplementation of QHttpHandler::process()
*/
virtual void process(QHttpSocket *socket, const QString &path);
private:
QObjectHandlerPrivate *const d;
friend class QObjectHandlerPrivate;
};
#endif // QHTTPENGINE_QOBJECTHANDLER_H
|