diff options
Diffstat (limited to 'docs/source/transport.md')
| -rw-r--r-- | docs/source/transport.md | 51 |
1 files changed, 29 insertions, 22 deletions
diff --git a/docs/source/transport.md b/docs/source/transport.md index 4719d7227..3e7844ad5 100644 --- a/docs/source/transport.md +++ b/docs/source/transport.md @@ -1,4 +1,4 @@ -# The Transport Library +# Transport library ## Introduction @@ -6,14 +6,16 @@ This library provides transport services and socket API for applications willing using the hICN protocol stack. Overview: - -- Implementation of the hICN core objects (interest, data, name..) exploiting the API provided by [libhicn](../lib). -- Connectors for connecting the application to either the hicn-plugin or the hicn-light forwarder. +- Implementation of the hICN core objects (interest, data, name..) exploiting + the API provided by [libhicn](../lib). +- Connectors for connecting the application to either the hicn-plugin or the + hicn-light forwarder. - Transport protocols (RAAQM, CBR, RTC) - Transport services (authentication, integrity, segmentation, reassembly, naming) -- Interfaces for applications (from low-level interfaces for interest-data interaction to high level interfaces for Application Data Unit interaction) +- Interfaces for applications (from low-level interfaces for interest-data + interaction to high level interfaces for Application Data Unit interaction) -## Build Dependencies +## Build dependencies ### Ubuntu @@ -21,31 +23,34 @@ Overview: - libmemif (linux only, if compiling with VPP support) - libasio -If you wish to use the library for connecting to the vpp hicn-plugin, you will need to also install vpp, the vpp libraries and the libmemif libraries: +If you wish to use the library for connecting to the vpp hicn-plugin, you will +need to also install vpp, the vpp libraries and the libmemif libraries: - DEB packages: - vpp - vpp-lib - vpp-dev -You can get them either from from the vpp packages ot the source code. Check the [VPP wiki](https://wiki.fd.io/view/VPP) for instructions. +You can get them either from from the vpp packages or the source code. Check +the [VPP wiki](https://wiki.fd.io/view/VPP) for instructions. ### macOS -We recommend to use [HomeBrew](https://brew.sh/) for installing the libasio dependency: +We recommend to use [HomeBrew](https://brew.sh/) for installing the libasio +dependency: ```bash - brew install asio +brew install asio ``` Download, compile and install libparc: ```bash - git clone -b cframework/master https://gerrit.fd.io/r/cicn cframework && cd cframework - mkdir -p libparc.build && cd libparc.build - cmake ../libparc - make - make install +git clone -b cframework/master https://gerrit.fd.io/r/cicn cframework && cd cframework +mkdir -p libparc.build && cd libparc.build +cmake ../libparc +make +make install ``` Libparc will be installed by default under `/usr/local/lib` and `/usr/local/include`. @@ -56,10 +61,10 @@ Since VPP does not support macOS, the hicn-plugin connector is not built. From the project root folder: ```bash - cd libtransport - mkdir build && cd build - cmake .. - make +cd libtransport +mkdir build && cd build +cmake .. +make ``` ### Compile options @@ -67,12 +72,14 @@ From the project root folder: The build process can be customized with the following options: - `CMAKE_INSTALL_PREFIX`: The path where you want to install the library. -- `CMAKE_BUILD_TYPE`: The build configuration. Options: `Release`, `Debug`. Default is `Release`. +- `CMAKE_BUILD_TYPE`: The build configuration. Options: `Release`, `Debug`. + Default is `Release`. - `ASIO_HOME`: The folder containing the libasio headers. - `LIBPARC_HOME`: The folder containing the libparc headers and libraries. - `VPP_HOME`: The folder containing the installation of VPP. - `LIBMEMIF_HOME`: The folder containing the libmemif headers and libraries. -- `BUILD_MEMIF_CONNECTOR`: On linux, set this value to `ON` for building the VPP connector. +- `BUILD_MEMIF_CONNECTOR`: On linux, set this value to `ON` for building the + VPP connector. An option can be set using cmake -D`OPTION`=`VALUE`. @@ -81,5 +88,5 @@ An option can be set using cmake -D`OPTION`=`VALUE`. For installing the library, from the cmake build folder: ```bash - sudo make install +sudo make install ``` |