Move rtaudio, alsa-playback and qxt into thirdparty/.

thirdparty/qxt/qxtweb-standalone/qxtweb/qxtabstractwebservice.cpp

@@ -0,0 +1,121 @@
+/****************************************************************************
+ **
+ ** Copyright (C) Qxt Foundation. Some rights reserved.
+ **
+ ** This file is part of the QxtWeb module of the Qxt library.
+ **
+ ** This library is free software; you can redistribute it and/or modify it
+ ** under the terms of the Common Public License, version 1.0, as published
+ ** by IBM, and/or under the terms of the GNU Lesser General Public License,
+ ** version 2.1, as published by the Free Software Foundation.
+ **
+ ** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY
+ ** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY
+ ** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR
+ ** FITNESS FOR A PARTICULAR PURPOSE.
+ **
+ ** You should have received a copy of the CPL and the LGPL along with this
+ ** file. See the LICENSE file and the cpl1.0.txt/lgpl-2.1.txt files
+ ** included with the source distribution for more information.
+ ** If you did not receive a copy of the licenses, contact the Qxt Foundation.
+ **
+ ** <http://libqxt.org>  <foundation@libqxt.org>
+ **
+ ****************************************************************************/
+
+/*!
+\class QxtAbstractWebService
+
+\inmodule QxtWeb
+
+\brief The QxtAbstractWebService class is a base interface for web services
+
+QxtAbstractWebService provides a common interface for all web service classes.
+It uses an event-driven design instead of the more traditional request-response
+design used by many web scripting languages. When the user requests a web
+page, the service receives a pageRequestedEvent; after the service assembles
+the response, it must post a QxtWebPageEvent (or a subclass, such as
+QxtWebRedirectEvent or QxtWebErrorEvent).
+
+Usually, an application providing web services will instantiate one
+QxtAbstractWebService object for each session, but this is not a requirement.
+For services that do not require session management, such as those that serve
+only static content, the session factory may return the same pointer for
+every invocation, or it may use some more exotic scheme.
+
+When using one service object per session, each service's data members are
+independent and may be used to track state across requests. A service object
+shared among multiple sessions will retain state across requests as well but
+it must implement its own mechanism for separating non-shared data.
+
+The QxtWeb architecture is not multithreaded; that is, QxtAbstractWebService
+does not automatically spawn a process for every session. However,
+QxtAbstractWebSessionManager performs thread-safe event dispatching, so
+subclasses of QxtAbstractWebService are free to create threads themselves.
+
+A web service object may delete itself (see QObject::deleteLater()) to end
+the associated session.
+
+\sa QxtAbstractWebSessionManager::ServiceFactory
+*/
+
+/*
+ * TODO:
+ * The current architecture only allows for two behaviors: creating a new session
+ * for every connection without a session cookie, or not using sessions at all.
+ * This needs to be fixed by adding a function to the session manager to explicitly
+ * create a new session.
+ */
+
+#include "qxtabstractwebservice.h"
+
+#ifndef QXT_DOXYGEN_RUN
+class QxtAbstractWebServicePrivate : public QxtPrivate<QxtAbstractWebService>
+{
+public:
+    QXT_DECLARE_PUBLIC(QxtAbstractWebService)
+    QxtAbstractWebServicePrivate() {}
+
+    QxtAbstractWebSessionManager* manager;
+};
+#endif
+
+/*!
+ * Creates a QxtAbstractWebService with the specified \a parent and session \a manager.
+ *
+ * Often, the session manager will also be the parent, but this is not a requirement.
+ *
+ * Note that this is an abstract class and cannot be instantiated directly.
+ */
+QxtAbstractWebService::QxtAbstractWebService(QxtAbstractWebSessionManager* manager, QObject* parent) : QObject(parent)
+{
+    QXT_INIT_PRIVATE(QxtAbstractWebService);
+    qxt_d().manager = manager;
+}
+
+/*!
+ * Returns the session manager associated with the web service.
+ */
+QxtAbstractWebSessionManager* QxtAbstractWebService::sessionManager() const
+{
+    return qxt_d().manager;
+}
+
+/*!
+ * \fn void QxtAbstractWebService::postEvent(QxtWebEvent* event)
+ * Posts an \a event to a web browser that has made a request to the service.
+ */
+
+/*!
+ * \fn virtual void QxtAbstractWebService::pageRequestedEvent(QxtWebRequestEvent* event)
+ * This \a event handler must be reimplemented in subclasses to receive page
+ * request events.
+ *
+ * Every page request event received MUST be responded to with a QxtWebPageEvent
+ * or a QxtWebPageEvent subclass. This response does not have to be posted
+ * during the execution of this function, to support asynchronous design, but
+ * failure to post an event will cause the web browser making the request to
+ * wait until it times out.
+ *
+ * \sa QxtWebRequestEvent
+ */