Repository files navigation

cpp-netlib is a collection of network related routines/implementationsgeared towards providing a robust cross-platform networking library.cpp-netlib offers the following implementations:

• Common Message Type -- A generic message type which can be usedto encapsulate and store message related information, used by allnetwork implementations as the primary means of data exchange.
• Network protocol message parsers -- A collection of parsers whichgenerate message objects from strings.
• Adapters and Wrappers -- A collection of Adapters and wrappers aimedtowards making the message type STL friendly.
• Network protocol client and server implementations -- A collectionof network protocol implementations that include embeddable clientand server types.

This library is released under the Boost Software License (please seehttp://boost.org/LICENSE_1_0.txt or the accompanying LICENSE_1_0.txt filefor the full text.

You can find official release packages of the library at:

http://github.com/cpp-netlib/cpp-netlib/downloads

The project contains submodules for some dependencies and somelibraries. Once you have cloned cpp-netlib, you must update thesubmodules:

$ cd ~/cpp-netlib$ git submodule init$ git submodule update

To build the libraries and run the tests with CMake, you will need tohave CMake version 2.8.10 or higher installed appropriately in yoursystem.

$ cmake --versioncmake version 2.8.10

Inside the cpp-netlib directory, you can issue the following statements toconfigure and generate the Makefiles, and build the tests:

$ cd ~/cpp-netlib-build # cmake is built out of source$ cmake ~/cpp-netlib \ # we're assuming it's where cpp-netlib is>       -DCMAKE_BUILD_TYPE=Debug     \>       -DCMAKE_C_COMPILER=clang     \>       -DCMAKE_CXX_COMPILER=clang++

Once CMake is done with generating the Makefiles and configuring the project,you can now build the tests and run them:

$ cd ~/cpp-netlib-build$ make$ make test

If for some reason some of the tests fail, you can send the files inTesting/Temporary/ as attachments to the cpp-netlibdevelopers mailinglist.

API documentation can be generated by running the following command:

$ cd ~/cpp-netlib-build$ make doc

The HTML output can be found in thehtml subdirectory.

If you want to run the tests that come with cpp-netlib, there are a few thingsyou will need. These are:

• A compiler (GCC 4.7.x, Clang 2.8, MSVC 2012)
• CMake[#]_
• OpenSSL headers (optional)

FreeBSD users can use the ports tree to install cpp-netlib:

$ cd /usr/ports/devel/cpp-netlib && make install clean

cpp-netlib is being developed with thegit distributed SCM system.cpp-netlib is hosted onGitHub following the GitHub recommended practice offorking the repository and submitting pull requests to the source repository.You can read more about theforking process and submittingpull requests ifyou're not familiar with either process yet.

Because cpp-netlib is released under theBoost Software License it isrecommended that any file you make changes to bear your copyright noticealongside the original authors' copyright notices on the file. Typically thecopyright notices are at the top of each file in the project.

At the time of writing, there are no coding conventions being followed but ifyou write in the general style that is already existing in the project thatwould be greatly appreciated. Copious amounts of comments will be called out,but code that is not self-explanatory typically at least requires a rationaledocumentation in comments explaining "why" the code is written that way.

The main "upstream" repository and official release repository ismaintained athttp://github.com/cpp-netlib/cpp-netlib. It isrecommended that forks and pull requests be submitted to the upstreamrepository so that patches and other implementations can be curated bythe project administrators.

In case you have any questions or would like to make feature requests, you cancontact the development team through thedevelopers mailing listor by filing issues athttp://github.com/cpp-netlib/cpp-netlib/issues.

You can reach the maintainers of the project through:

Dean Michael Berris (dberris@google.com)Glyn Matthews (glyn.matthews@gmail.com)