Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for make install command #44

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# 3rdparty, tmp and build direcotry
3rdparty/
tmp/
xbin/
build/
Expand Down
3 changes: 3 additions & 0 deletions .qmake.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
load(qt_build_config)

MODULE_VERSION = 5.0.0
175 changes: 159 additions & 16 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,22 +1,165 @@
The MIT License (MIT)
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (c) 2014 Amir Zamani
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

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.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

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.
0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
80 changes: 6 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
- [Features](#features)
- [Setup](#setup)
- [Multi-threading](#multi-threading)
- [Source tree](#source-tree)
- [Disclaimer](#disclaimer)
- [License](#license)

Expand Down Expand Up @@ -66,46 +65,6 @@ int main(int argc, char** argv) {
}
```

to request weather information by **HTTP client**:
```cpp
int main(int argc, char** argv) {
QCoreApplication app(argc, argv);

using namespace qhttp::client;
QHttpClient client(&app);
QUrl weatherUrl("http://wttr.in/tehran");

client.request(qhttp::EHTTP_GET, weatherUrl, [](QHttpResponse* res) {
// response handler, called when the incoming HTTP headers are ready

// gather HTTP response data (HTTP body)
res->collectData();

// when all data in HTTP response have been read:
res->onEnd([&]() {
writeTo("weather.html", res->collectedData());

// done! now quit the application
qApp->quit();
});

// just for fun! print incoming headers:
qDebug("\n[Headers:]");
res->headers().forEach([](auto cit) {
qDebug("%s : %s", cit.key().constData(), cit.value().constData());
});
});

// set a timeout for the http connection
client.setConnectingTimeOut(10000, []{
qDebug("connecting to HTTP server timed out!");
qApp->quit();
});

return app.exec();
}
```


## Features
[TOC](#table-of-contents)
Expand Down Expand Up @@ -148,18 +107,19 @@ int main(int argc, char** argv) {
instructions:
```bash
# first clone this repository:
$> git clone https://github.com/azadkuh/qhttp.git
$> git clone https://github.com/Aseman-Land/qhttp.git
$> cd qhttp

# prepare dependencies:
$qhttp/> ./update-dependencies.sh

# now build the library and the examples
$qhttp/> qmake -r qhttp.pro
$qhttp/> make -j 8
$qhttp/> make
$qhttp/> make install
```

And add it using ```Qt += http``` to your project :)

## Multi-threading

[TOC](#table-of-contents)

As `QHttp` is **asynchronous** and **non-blocking**, your app can handle
Expand All @@ -176,34 +136,6 @@ in some rare scenarios you may want to use multiple handler threads (although
other handler threads.


## Source tree
[TOC](#table-of-contents)


- **`src/`**: holds the source code of `QHttp`. server classes are prefixed by
`qhttpserver*` and client classes by `qhttpclient*`.
- **`private/`**: Private classes of the library.
- **`3rdparty/`**: will contain `http-parser` source tree as the only
dependency. this directory is created by setup. see also: [setup](#setup).
- **`example/`**: contains some sample applications representing the `QHttp`
usage:
- **`helloworld/`**: the HelloWorld example of `QHttp`, both server + client
are represented. see: [README@helloworld](./example/helloworld/README.md)
- **`basic-server/`**: a basic HTTP server shows how to collect the request
body, and respond to the clients. see:
[README@basic-server](./example/basic-server/README.md)
- **`keep-alive`**: shows how to keep an http connection open and
transmitting many requests/responses. see:
[README@keep-alive](./example/keep-alive/README.md)
- **`post-collector`**: another server example shows how to collect large
data by POST requests. see:
[README@post-collector](./example/postcollector/README.md)
- **`tmp/`**: a temporary directory which is created while `make`ing the
library and holds all the `.o`, `moc files`, etc.
* **`xbin/`**: all the executable and libraries will be placed on this folder by
build system.



## Disclaimer
[TOC](#table-of-contents)
Expand Down
29 changes: 0 additions & 29 deletions commondir.pri

This file was deleted.

10 changes: 0 additions & 10 deletions example/example.pro

This file was deleted.

3 changes: 3 additions & 0 deletions examples/examples.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
TEMPLATE = subdirs
SUBDIRS = http

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions examples/http/http.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TEMPLATE = subdirs
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions modules/qt_http.pri
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
QT.http.VERSION = 5.0.0
QT.http.MAJOR_VERSION = 5
QT.http.MINOR_VERSION = 0
QT.http.PATCH_VERSION = 0

QT.http.name = QtHttp
QT.http.bins = $$QT_MODULE_BIN_BASE
QT.http.includes = $$QT_MODULE_INCLUDE_BASE $$QT_MODULE_INCLUDE_BASE/QtHttp
QT.http.private_includes = $$QT_MODULE_INCLUDE_BASE/QtHttp/$$QT.http.VERSION
QT.http.sources = $$QT_MODULE_BASE/src/http
QT.http.libs = $$QT_MODULE_LIB_BASE
QT.http.plugins = $$QT_MODULE_PLUGIN_BASE
QT.http.imports = $$QT_MODULE_IMPORT_BASE
QT.http.depends = core network
7 changes: 1 addition & 6 deletions qhttp.pro
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
TEMPLATE = subdirs

SUBDIRS += src
SUBDIRS += example

example.depends = src
load(qt_parts)
Loading