| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 1 | # jndn-management |
| 2 | |
| 3 | This project is a consists of tools for managing an NDN forwarding daemon (NFD). It relies on the [NDN Protocol](https://named-data.net) and its associated [client library](https://github.com/named-data/jndn). It implements the NFD management pecification outlined at http://redmine.named-data.net/projects/nfd/wiki/Management. |
| 4 | |
| 5 | ## Install |
| 6 | With Maven, add the following to your POM: |
| 7 | ``` |
| 8 | <dependency> |
| 9 | <groupId>com.intel.jndn.management</groupId> |
| 10 | <artifactId>jndn-management</artifactId> |
| 11 | <version>RELEASE</version> <!-- or a specific version --> |
| 12 | </dependency> |
| 13 | ``` |
| 14 | |
| 15 | ## Use |
| 16 | With a Face that has command signing information set, call any of the following static methods: |
| 17 | - __NFD.pingLocal(Face forwarder)__: ping a local NFD with /localhost/nfd to verify if it exists. |
| 18 | - __NFD.getFaceList(Face forwarder)__: retrieve all connected faces. |
| 19 | - __NFD.getFibList(Face forwarder)__: retrieve all forwarding entries in the Forwarding Information Base (FIB). |
| 20 | - __NFD.getRibList(Face forwarder)__: retrieve all routing entries in the Routing Information Base (RIB). |
| 21 | - __NFD.createFace(Face forwarder, String uri)__: create a new face on the NFD opened to the given URI. |
| Andrew Brown | d5f6f69 | 2015-02-20 17:43:05 -0800 | [diff] [blame^] | 22 | - __NFD.register(Face forwarder, ...)__: includes several similar methods for registering a new route on the NFD. |
| 23 | - __NFD.unregister(Face forwarder, Name route)__: unregister a route by name. |
| 24 | |
| 25 | ## License |
| 26 | This library is licensed under LGPLv3, see LICENSE. |