Project

General

Profile

Step-By-Step - Common Client Libraries » History » Version 21

Anonymous, 12/18/2015 03:14 PM

1 1 Anonymous
Step-By-Step - Common Client Libraries
2
======================================
3
4 2 Anonymous
This document step-by-step how to get a minimal [NFD](https://github.com/named-data/NFD) running so you can start writing applications to use the NDN [Common Client Libraries](http://named-data.net/doc/ndn-ccl-api/) ([NDN-CPP](https://github.com/named-data/ndn-cpp), [NDN-JS](https://github.com/named-data/ndn-js), [PyNDN](https://github.com/named-data/PyNDN2), [jNDN](https://github.com/named-data/jndn)).
5 1 Anonymous
6
# Prerequisites
7
8 10 Anonymous
## OS X 10.9, OS X 10.10.2, OS X 10.11
9 1 Anonymous
10
* Install Xcode.
11 7 Anonymous
* (OS X 10.8.4 only) In Xcode Preferences > Downloads, install "Command Line Tools".
12 6 Anonymous
* Install MacPorts from http://www.macports.org/install.php
13
14 7 Anonymous
In a new terminal, enter:
15 1 Anonymous
16
    sudo port install pkgconfig boost sqlite3 libcryptopp libpcap
17
18
To build NFD, we need `/usr/local/lib/pkgconfig` in the environment variable `PKG_CONFIG_PATH`, so we set it here. If you close your terminal before building NFD, you should set this again.
19
20
    export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig
21
22
## Ubuntu 12.04
23
24
In a terminal, enter:
25
26 11 Anonymous
    sudo apt-get install build-essential git libssl-dev libsqlite3-dev libcrypto++-dev libpcap-dev libboost1.48-all-dev
27 1 Anonymous
28 20 Anonymous
## Ubuntu 13.10, Ubuntu 14.04 and Ubuntu 15.04
29 1 Anonymous
30
In a terminal, enter:
31
32 12 Anonymous
    sudo apt-get install build-essential git libssl-dev libsqlite3-dev libcrypto++-dev libpcap-dev libboost-all-dev
33 1 Anonymous
34 20 Anonymous
## Raspbian Jessie (Rapberry Pi)
35
36
In a terminal, enter:
37
38 21 Anonymous
    sudo apt-get install build-essential git libssl-dev libsqlite3-dev libcrypto++-dev libpcap-dev libboost1.50-all-dev
39 1 Anonymous
40 3 Anonymous
To run NFD on the Raspberry Pi, you need to enable IPv6 support. Enter `sudo nano /etc/modules` (or use your favorite editor). Add the following line to `/etc/modules`:
41 1 Anonymous
42
    ipv6
43
44
Reboot your Raspberry Pi.
45
46
(If you don't want to enable IPv6 support on the Raspberry Pi, you can disable IPv6 in NFD. After installing NFD, replace `enable_v6 yes` with `enable_v6 no` in the `tcp` and `udp` sections of `/usr/local/etc/ndn/nfd.conf` .)
47
48
# Build/Install NFD
49
50 18 Anonymous
These are steps from [build/install NFD](http://named-data.net/doc/NFD/current/INSTALL.html) which work with the CCL.  In a terminal, enter:
51 1 Anonymous
52 4 Anonymous
    git clone https://github.com/named-data/ndn-cxx
53
    git clone --recursive https://github.com/named-data/NFD
54 1 Anonymous
    cd ndn-cxx
55
    ./waf configure
56
57
If waf says "program doxygen not found", "program sphinx-build not found" or "library rt not found", it is OK.
58
59
    ./waf
60
    sudo ./waf install
61
    cd ..
62
    cd NFD
63
    ./waf configure
64
65
If waf says "libndn-cxx not found", then set `PKG_CONFIG_PATH` as shown in the Prerequisites above.
66
67
    ./waf
68
    sudo ./waf install
69
    cd ..
70
71
The NFD programs are installed in `/usr/local/bin` . The NFD configuration file is in `/usr/local/etc/ndn` .  Copy the sample configuration file to make it the default:
72
73
    sudo cp /usr/local/etc/ndn/nfd.conf.sample /usr/local/etc/ndn/nfd.conf
74 13 Anonymous
75
### Ubuntu
76
77 14 Anonymous
[Ubuntu only] Update the path to the shared libraries:
78 13 Anonymous
79 15 Anonymous
    sudo /sbin/ldconfig
80 1 Anonymous
81
# Configure NFD
82
83
NFD provides mechanisms to enable strict authorization for all management commands.  In particular, one can authorize only a specific public key to create new Faces or to change the strategy choice for specific namespaces.
84
For more information about how to generate a private/public key pair, generate a self-signed certificate, and use this self-signed certificate to authorize NFD management commands, refer to [NFD Configuration Tips](http://named-data.net/doc/NFD/current/README.html).
85
86
In the sample configuration file, all authorization is disabled, effectively allowing anybody on the local machine to issue NFD management commands. **The sample file is intended only for demo purposes and MUST NOT be used in a production environment.**
87
88
## Start NFD
89
90
Open a new terminal window (so you can watch the NFD messages) and enter:
91
92
    nfd-start
93
94
On OS X it may ask for your keychain password or ask "nfd wants to sign using key in your keychain." Enter your keychain password and click Always Allow.
95
96
Later, you can stop NFD with `nfd-stop` .
97
98
## Add a route to another NFD host (optional)
99
100
The previous instructions are good for testing on the local host. If you want to route an interest to another NFD host, in a terminal enter:
101
102
    nfdc register /ndn udp://<other host>
103
104
where `<other host>` is the name or IP address of the other host (e.g., `spurs.cs.ucla.edu`). The "/ndn" means that NFD will forward all interests that start with `/ndn` through the face to the other host.  If you only want to forward interests with a certain prefix then use it instead of "/ndn".
105
106
This only forwards interests to the other host, but there is no "back route" for the other host to forward interests to you. For that, you must go to the other host and use `nfdc` to add the route. (The "back route" can also be automatically configured with `nfd-autoreg`.  For more information refer to [nfd-autoreg manpage](http://named-data.net/doc/NFD/current/manpages/nfd-autoreg.html).)
107
108
# Install the Common Client Library
109
110
If you haven't done so, get the library from GitHub and follow the INSTALL instructions for your language:
111
112 5 Anonymous
* C++: [NDN-CPP](https://github.com/named-data/ndn-cpp) ([INSTALL](https://github.com/named-data/ndn-cpp/blob/master/INSTALL.md) instructions)
113
* Python: [PyNDN2](https://github.com/named-data/PyNDN2) ([INSTALL](https://github.com/named-data/PyNDN2/blob/master/INSTALL.md) instructions)
114
* JavaScript: [NDN-JS](https://github.com/named-data/ndn-js) ([INSTALL](https://github.com/named-data/ndn-js/blob/master/INSTALL) instructions)
115
* JavaScript: [jNDN](https://github.com/named-data/jndn) ([INSTALL](https://github.com/named-data/jndn/blob/master/INSTALL.md) instructions)
116 1 Anonymous
117
# Send an Interest to receive a Data packet
118
119
The example program "test get async" is a simple program to send some interests and get a data packet.  Here they are on the various languages:
120
121
* C++: [`test-get-async.cpp`](https://github.com/named-data/ndn-cpp/blob/master/tests/test-get-async.cpp)
122
* Python: [`test_get_async.py`](https://github.com/named-data/PyNDN2/blob/master/tests/test_get_async.py)
123
* JavaScript (browser): [`test-get-async.html`](https://github.com/named-data/ndn-js/blob/master/tests/browser/test-get-async.html)
124
* JavaScript (node): [`fetch.js`](https://github.com/named-data/ndn-js/blob/master/tests/node/fetch.js)
125 5 Anonymous
* Java: [`TestGetAsync.java`](https://github.com/named-data/jndn/blob/master/tests/src/net/named_data/jndn/tests/TestGetAsync.java)
126 1 Anonymous
127
The main calls to the API are (using Python for example):
128
129
Call the [Face constructor](http://named-data.net/doc/ndn-ccl-api/face.html#face-constructors) and specify the host.
130
131
    face = Face("aleph.ndn.ucla.edu")
132
133
134
Create a [Name](http://named-data.net/doc/ndn-ccl-api/name.html#name-constructor-from-uri) for the Interest, using a Name URI.
135
136
    name1 = Name("/ndn/edu/ucla/remap/ndn-js-test/howdy.txt")
137
138
Call [expressInterest](http://named-data.net/doc/ndn-ccl-api/face.html#face-expressinterest-method-from-name), passing in the callbacks for onData and onTimeout.
139
140
    face.expressInterest(name1, counter.onData, counter.onTimeout)
141
142
Start an event loop to keep calling [processEvents](http://named-data.net/doc/ndn-ccl-api/face.html#face-processevents-method) until the application is finished.
143
Your application should make sure that it calls processEvents in the same thread as expressInterest (which also modifies the pending interest table).
144
145
    while counter._callbackCount < 3:
146
        face.processEvents()
147
        # We need to sleep for a few milliseconds so we don't use 100% of the CPU.
148
        time.sleep(0.01)