Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cpp-netlib/cpp-netlib

The C++ Network Library Project -- cross-platform, standards compliant networking library.
https://github.com/cpp-netlib/cpp-netlib

Last synced: about 2 months ago
JSON representation

The C++ Network Library Project -- cross-platform, standards compliant networking library.

Awesome Lists containing this project

README 

        
C++ Network Library

===================



Modern C++ network programming libraries.



.. image:: https://travis-ci.org/cpp-netlib/cpp-netlib.svg?branch=master

    :target: https://travis-ci.org/cpp-netlib/cpp-netlib



.. image:: https://scan.coverity.com/projects/6714/badge.svg

    :target: https://scan.coverity.com/projects/cpp-netlib



.. image:: https://img.shields.io/badge/license-boost-blue.svg

    :target: https://github.com/cpp-netlib/cpp-netlib/blob/master/LICENSE_1_0.txt



Join us on Slack: http://slack.cpp-netlib.org/



Subscribe to the mailing list: https://groups.google.com/forum/#!forum/cpp-netlib



Downloading cpp-netlib

----------------------



You can find official release packages of the library at::



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



If you want the latest code from the master branch of the project, you can

follow these instructions for cloning the project repository::



    $ git clone https://github.com/cpp-netlib/cpp-netlib

    $ cd cpp-netlib

    $ git submodule init

    $ git submodule update



Introduction

------------



cpp-netlib is a collection of network-related routines/implementations

geared towards providing a robust cross-platform networking library.

cpp-netlib offers the following implementations:



  *  Common Message Type -- A generic message type which can be used

     to encapsulate and store message-related information, used by all

     network implementations as the primary means of data exchange.

  *  Network protocol message parsers -- A collection of parsers which

     generate message objects from strings.

  *  Adapters and Wrappers -- A collection of Adapters and wrappers aimed

     towards making the message type STL friendly.

  *  Network protocol client and server implementations -- A collection

     of network protocol implementations that include embeddable client

     and server types.



This library is released under the Boost Software License (please see

http://boost.org/LICENSE_1_0.txt or the accompanying LICENSE_1_0.txt file

for the full text.



Building and Installing

-----------------------



To build the libraries you will need to have CMake version 2.8 or higher

installed appropriately in your system.



::



    $ cmake --version

    cmake version 2.8.1



It is recommended that you build cpp-netlib outside of the source directory, to

avoid having issues with CMake generated files polluting the source directory::



    $ mkdir ~/cpp-netlib-build

    $ cd ~/cpp-netlib-build

    $ cmake -DCMAKE_BUILD_TYPE=Debug     \

    >       -DCMAKE_C_COMPILER=clang     \

    >       -DCMAKE_CXX_COMPILER=clang++ \

    >       $HOME/cpp-netlib    # we're assuming this is where cpp-netlib is.



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



You can also download and install cpp-netlib using the ` vcpkg`_ dependency manager:

    

    $ git clone https://github.com/Microsoft/vcpkg.git

    $ cd vcpkg

    $ ./bootstrap-vcpkg.sh

    $ ./vcpkg integrate install

    $ vcpkg install cpp-netlib

    

The cpp-netlib port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the ` vcpkg`_ repository.



.. _`vcpkg`: https://github.com/Microsoft/vcpkg



If for some reason some of the tests fail, you can send the files in

``Testing/Temporary/`` as attachments to the cpp-netlib `developers mailing

list`_.



.. _`developers mailing list`: [email protected]



Running Tests

-------------



If you want to run the tests that come with cpp-netlib, there are a few things

you will need. These are:



  * A compiler (GCC 4.x, Clang 3.6, MSVC 2008)

  * A build tool (CMake_ is required)

  * OpenSSL headers (optional)



.. note:: This assumes that you have cpp-netlib at the top-level of

          your home directory.

.. _CMake: https://cmake.org/



Hacking on cpp-netlib

---------------------



cpp-netlib uses git_ for tracking work and is hosted on GitHub_. 

cpp-netlib is hosted on GitHub_ following the GitHub recommended practice of

forking the repository and submitting pull requests to the source repository.

You can read more about the forking_ process and submitting `pull requests`_ if

you're not familiar with either process yet. cpp-netib follows the GitHub pull

request model for accepting patches. You can read more about the process at

http://cpp-netlib.org/process.html#pull-requests. 



.. _git: http://git-scm.com/

.. _GitHub: http://github.com/

.. _forking: http://help.github.com/forking/

.. _`pull requests`: http://help.github.com/pull-requests/



Because cpp-netlib is released under the `Boost Software License`_ it is

recommended that any file you make changes to bear your copyright notice

alongside the original authors' copyright notices on the file. Typically the

copyright notices are at the top of each file in the project.



.. _`Boost Software License`: http://www.boost.org/LICENSE_1_0.txt



You can read about the cpp-netlib style guide at

http://cpp-netlib.org/style-guide.html.



The main "upstream" repository is at http://github.com/cpp-netlib/cpp-netlib.



Contact and Support

-------------------



In case you have any questions or would like to make feature requests, you can

contact the development team through the `developers mailing list`_

or by filing issues at http://github.com/cpp-netlib/cpp-netlib/issues.



Join us on Slack: http://slack.cpp-netlib.org/



.. _`developers mailing list`: [email protected]



You can reach the maintainers of the project through::



    Dean Michael Berris ([email protected])



    Glyn Matthews ([email protected])