A CCNx base API
$ git clone git@github.com:PARC/Libccnx-portal.git Libccnx-portal
$ mkdir Libccnx-portal.build
$ cd Libccnx-portal.build
$ cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ../Libccnx-portal
$ make
$ make test
$ make install
The CCNx Portal API is a simple API to communicate via Interests and Content Objects. It connects to a transport stack (like Transport RTA).
Libccnx-portal is part of CCNx Distillery. You may want to get the software via that distribution if you want to work on CCNx.
Libccnx-portal has been tested in:
- Ubuntu 14.04 (x86_64)
- MacOSX 10.10
- MacOSX 10.11
Other platforms and architectures may work.
Build dependencies:
- c99 ( clang / gcc )
- CMake 3.4
Basic dependencies:
- OpenSSL
- pthreads
- Libevent
- LongBow
- Libparc
- Libccnx-common
- Libccnx-transport-rta
Documentation dependencies:
- Doxygen
Libccnx-portal is built using cmake. You will need to have CMake 3.4 installed in order to build it.
Download Libccnx-portal
$ git clone git@github.com:PARC/Libccnx-portal.git Libccnx-portal
Create build directory
$ mkdir Libccnx-portal.build
$ cd Libccnx-portal.build
Prepare the build, give an install directory
$ cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ../Libccnx-portal
Compile the software
$ make
Run unit tests
$ make test
Install the software
$ make install
This will create the include and lib directories containing the necessary files to compile with LongBow in the ${INSTALL_DIR}.
Libccnx-portal is a set of functions and data structures for C. You can use it in your code by including the right header files and linking to the Libccnx_api_portal library.
CCNX_HOME=<directory-where-Libccnx-portal-is-installed>
-I${CCNX_HOME}/include -L${CCNX_HOME}/lib -lccnx_api_portal
This software is distributed under the following license:
Copyright (c) 2013,2014,2015,2016, Xerox Corporation (Xerox) and Palo Alto Research Center, Inc (PARC)
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL XEROX OR PARC BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
################################################################################
#
# PATENT NOTICE
#
# This software is distributed under the BSD 2-clause License (see LICENSE
# file). This BSD License does not make any patent claims and as such, does
# not act as a patent grant. The purpose of this section is for each contributor
# to define their intentions with respect to intellectual property.
#
# Each contributor to this source code is encouraged to state their patent
# claims and licensing mechanisms for any contributions made. At the end of
# this section contributors may each make their own statements. Contributor's
# claims and grants only apply to the pieces (source code, programs, text,
# media, etc) that they have contributed directly to this software.
#
# There is no guarantee that this section is complete, up to date or accurate. It
# is up to the contributors to maintain their portion of this section and up to
# the user of the software to verify any claims herein.
#
# Do not remove this header notification. The contents of this section must be
# present in all distributions of the software. You may only modify your own
# intellectual property statements. Please provide contact information.
- Palo Alto Research Center, Inc
This software distribution does not grant any rights to patents owned by Palo
Alto Research Center, Inc (PARC). Rights to these patents are available via
various mechanisms. As of January 2016 PARC has committed to FRAND licensing any
intellectual property used by its contributions to this software. You may
contact PARC at cipo@parc.com for more information or visit http://www.ccnx.org