Project

General

Profile

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

Anonymous, 10/13/2014 11:08 AM

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
## OS X 10.7.3, OS X 10.8.4, OS X 10.9
9
10
* Install Xcode.
11
* (OS X 10.7.3, OS X 10.8.4 only) In Xcode Preferences > Downloads, install "Command Line Tools".
12
* Install MacPorts from http://www.macports.org/install.php
13
14
In a terminal, enter:
15
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
    sudo apt-get install build-essential
27
    sudo apt-get install git libssl-dev libsqlite3-dev libcrypto++-dev libpcap-dev libboost1.48-all-dev
28
29
## Ubuntu 13.10, Ubuntu 14.04 and Raspbian Wheezy (Rapberry Pi)
30
31
In a terminal, enter:
32
33
    sudo apt-get install build-essential
34
    sudo apt-get install git libssl-dev libsqlite3-dev libcrypto++-dev libpcap-dev libboost-all-dev
35
36
### Raspberry Pi
37
38 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`:
39 1 Anonymous
40
    ipv6
41
42
Reboot your Raspberry Pi.
43
44
(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` .)
45
46
# Build/Install NFD
47
48
These are steps to [build/install NFD](http://named-data.net/doc/NFD/current/INSTALL.html) which works with NFD.  In a terminal, enter:
49
50
    git clone https://github.com/named-data/ndn-cxx.git
51
    git clone https://github.com/named-data/NFD.git
52
    cd ndn-cxx
53
    ./waf configure
54
55
If waf says "program doxygen not found", "program sphinx-build not found" or "library rt not found", it is OK.
56
57
    ./waf
58
    sudo ./waf install
59
    cd ..
60
    cd NFD
61
    git submodule init && git submodule update
62
    ./waf configure
63
64
If waf says "libndn-cxx not found", then set `PKG_CONFIG_PATH` as shown in the Prerequisites above.
65
66
    ./waf
67
    sudo ./waf install
68
    cd ..
69
70
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:
71
72
    sudo cp /usr/local/etc/ndn/nfd.conf.sample /usr/local/etc/ndn/nfd.conf
73
74
# Configure NFD
75
76
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.
77
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).
78
79
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.**
80
81
## Start NFD
82
83
If you have NDNx or ndnd-tlv on your computer, you don't need to uninstall. But if they are running, you need to stop them:
84
85
    ndnd-tlv-stop
86
    ndndstop
87
88
Open a new terminal window (so you can watch the NFD messages) and enter:
89
90
    nfd-start
91
92
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.
93
94
Later, you can stop NFD with `nfd-stop` .
95
96
## Add a route to another NFD host (optional)
97
98
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:
99
100
    nfdc register /ndn udp://<other host>
101
102
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".
103
104
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).)
105
106
# Install the Common Client Library
107
108
If you haven't done so, get the library from GitHub and follow the INSTALL instructions for your language:
109
110
* C++: [ndn-cpp](https://github.com/named-data/ndn-cpp) ([INSTALL](https://github.com/named-data/ndn-cpp/blob/master/INSTALL) instructions)
111
* Python: [PyNDN2](https://github.com/named-data/PyNDN2) ([INSTALL](https://github.com/named-data/PyNDN2/blob/master/INSTALL) instructions)
112
* JavaScript: [ndn-js](https://github.com/named-data/ndn-js) ([INSTALL](https://github.com/named-data/ndn-js/blob/master/INSTALL) instructions)
113
114
# Send an Interest to receive a Data packet
115
116
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:
117
118
* C++: [`test-get-async.cpp`](https://github.com/named-data/ndn-cpp/blob/master/tests/test-get-async.cpp)
119
* Python: [`test_get_async.py`](https://github.com/named-data/PyNDN2/blob/master/tests/test_get_async.py)
120
* JavaScript (browser): [`test-get-async.html`](https://github.com/named-data/ndn-js/blob/master/tests/browser/test-get-async.html)
121
* JavaScript (node): [`fetch.js`](https://github.com/named-data/ndn-js/blob/master/tests/node/fetch.js)
122
123
The main calls to the API are (using Python for example):
124
125
Call the [Face constructor](http://named-data.net/doc/ndn-ccl-api/face.html#face-constructors) and specify the host.
126
127
    face = Face("aleph.ndn.ucla.edu")
128
129
130
Create a [Name](http://named-data.net/doc/ndn-ccl-api/name.html#name-constructor-from-uri) for the Interest, using a Name URI.
131
132
    name1 = Name("/ndn/edu/ucla/remap/ndn-js-test/howdy.txt")
133
134
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.
135
136
    face.expressInterest(name1, counter.onData, counter.onTimeout)
137
138
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.
139
Your application should make sure that it calls processEvents in the same thread as expressInterest (which also modifies the pending interest table).
140
141
    while counter._callbackCount < 3:
142
        face.processEvents()
143
        # We need to sleep for a few milliseconds so we don't use 100% of the CPU.
144
        time.sleep(0.01)