MQUIC Message Queue over UDP Internet Connection

========== proto-quic

proto-quic is intended as a standalone library for QUIC.

It contains the subset of Chromium code and dependencies required for QUIC so folks can use the Chromium code without depending on all of Chromium. It is intended to be a cross-platform library, but will only support the set (or a strict subset) of platforms which Chromium already supports.

This is not an officially supported Google product. It's being kept up to date (on a theoretical weekly basis) as a best-effort side-project by some of the current QUIC developers. Worst case, should Google's priorities change about supporting a standalone QUIC library, it's all open source and any interested community can just clone the repo and continue updates on their own.

Currently, the only supported platform is Linux (and the only tested version is Google's Ubuntu clone) but Windows and iOS should be coming soon.

Building on Linux

0. Clone this repository and install dependencies

   git clone https://github.com/google/proto-quic.git
   cd proto-quic
   export PATH=$PATH:`pwd`/depot_tools
   

./src/build/install-build-deps.sh

0. Build the QUIC client, server, and tests

cd src gclient runhooks ./build/gyp_chromium -Dcomponent=shared_library ninja -C out/Release quic_client quic_server net_unittests

From then on you can follow the usual Chromium instructions for playing with the
toy client and server:

https://www.chromium.org/quic/playing-with-quic

QUIC, a multiplexed stream transport over UDP
=============================================

QUIC is an experimental protocol aimed at reducing web latency over that of TCP.
On the surface, QUIC is very similar to TCP+TLS+SPDY implemented on UDP. Because
TCP is implemented in operating system kernels, and middlebox firmware, making
significant changes to TCP is next to impossible. However, since QUIC is built
on top of UDP, it suffers from no such limitations.

Key features of QUIC over existing TCP+TLS+SPDY include

* Dramatically reduced connection establishment time
* Improved congestion control
* Multiplexing without head of line blocking
* Forward error correction
* Connection migration

See [Chromium QUIC Page](http://www.chromium.org/quic) for detailed information.

## libquic

This repository is sources and dependencies extracted from
[Chromium's QUIC Implementation](https://chromium.googlesource.com/chromium/src.git/+/master/net/quic/)
with a few modifications and patches to minimize dependencies needed to build
QUIC library.

Notable and only dependency is [BoringSSL](https://boringssl.googlesource.com/).
The BoringSSL sources is already embedded in this repository and linked with
CMake build file. You don't need any kind of dependency installs.

## Language Bindings

This library is intended as an essential reference point for other language
bindings and possibly for integration with other C/C++ codebase such as HTTP
servers like Apache or nginx.

Currently there is only one experimental language binding:

* Go binding: [goquic](https://github.com/devsisters/goquic)


Getting Started
===============

## How to build

Building with CMake and [Ninja](http://martine.github.io/ninja/) (Recommended):

```bash
$ mkdir build/
$ cd build/
$ cmake -GNinja ..
$ ninja

Building with CMake and Make:

$ mkdir build/
$ cd build/
$ cmake ..
$ make -j

libquic.a library file will be generated. libssl.a, libcrypto.a will be located in build/boringssl directory.

To do release builds run $ cmake -GNinja -DCMAKE_BUILD_TYPE=Release .. instead of $ cmake -GNinja ...

How to integrate

In order to integrate libquic to your code, your best source of documentation is official Chromium QUIC toy client and server. Golang binding will help too.

• QUIC toy client and server
• goquic C++ code

Syncing from Upstream

Great effort has been made to make syncing from upstream Chromium sources as effortless as possible. See DEPS file for all the dependencies. See manage.py script for actual syncing.

If you want to apply upstream chnages,

1. Clone & Checkout chromium upstream.
2. Build QUIC server: cd out/Debug; ninja quic_server
3. Update "chromium_revision" var at DEPS to your chromium source code revision.
4. Do ./manage.py sync --without-patches <CHROMIUM_GIT_ROOT> All necessary files will be updated to new ones without patches applied.
5. Temporarily commit here.
6. Do ./manage.py sync <CHROMIUM_GIT_ROOT> All the patches will be applied. Some patches will be rejected.
7. If there is any patch collision, manually apply the rejected patches. Open the *.rej files and carefully apply the rejected hunks manually.
8. Try build, and you'll find that you may need to add additional modifications to make build successful. There may be added or deleted source files. Update CMakeLists.txt accordingly.
9. If the build is successful, make a patch by: git diff src/ > patch/basepatch.patch (Make sure you don't include custom/ directory sources to the patch)
10. Add patch file to DEPS or update existing patch files. Amend previous commit.
11. Commit DEPS, new patch, and source changes