| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 1 | # jndn-management |
| 2 | |
| Alexander Afanasyev | 60f8f8e | 2018-07-25 13:24:19 -0400 | [diff] [blame] | 3 | This project 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 specification outlined at https://redmine.named-data.net/projects/nfd/wiki/Management. Please note that this library does not yet implement all of the commands in the management specification. |
| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 4 | |
| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 5 | ## Use |
| Davide Pesavento | 37505c1 | 2019-09-24 12:01:50 -0400 | [diff] [blame] | 6 | |
| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 7 | With a Face that has command signing information set, call any of the following static methods: |
| andrewsbrown | af0b273 | 2016-02-22 16:57:44 -0800 | [diff] [blame] | 8 | - __Nfdc.pingLocal(Face forwarder)__: ping a local NFD with /localhost/nfd to verify if it exists. |
| 9 | - __Nfdc.getForwarderStatus(Face forwarder)__: retrieve the forwarder status information. |
| 10 | - __Nfdc.getFaceList(Face forwarder)__: retrieve all connected faces. |
| 11 | - __Nfdc.getFibList(Face forwarder)__: retrieve all forwarding entries in the Forwarding Information Base (FIB). |
| 12 | - __Nfdc.getRibList(Face forwarder)__: retrieve all routing entries in the Routing Information Base (RIB). |
| 13 | - __Nfdc.getChannelStatusList(Face forwarder)__: Retrieve the list of channel status entries from the NFD. |
| 14 | - __Nfdc.createFace(Face forwarder, String uri)__: create a new face on the NFD opened to the given URI. |
| 15 | - __Nfdc.register(Face forwarder, ...)__: includes several similar methods for registering a new route on the NFD. |
| 16 | - __Nfdc.unregister(Face forwarder, Name route)__: unregister a route by name. |
| 17 | - __Nfdc.setStrategy(Face forwarder, Name prefix, Name strategy)__: set the forwarding strategy for the given prefix. |
| Andrew Brown | d5f6f69 | 2015-02-20 17:43:05 -0800 | [diff] [blame] | 18 | |
| andrewsbrown | 6b342ce | 2015-03-24 09:46:47 -0700 | [diff] [blame] | 19 | See [full Javadoc documentation](http://01org.github.io/jndn-management/index.html) |
| 20 | |
| Andrew Brown | d5f6f69 | 2015-02-20 17:43:05 -0800 | [diff] [blame] | 21 | ## License |
| Davide Pesavento | 37505c1 | 2019-09-24 12:01:50 -0400 | [diff] [blame] | 22 | |
| 23 | Copyright © 2015, Intel Corporation. |
| andrewsbrown | 7e6b9e8 | 2015-03-03 16:11:11 -0800 | [diff] [blame] | 24 | |
| Davide Pesavento | 399f0b9 | 2020-04-17 18:31:26 -0400 | [diff] [blame^] | 25 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 3, as published by the Free Software Foundation. |
| andrewsbrown | 7e6b9e8 | 2015-03-03 16:11:11 -0800 | [diff] [blame] | 26 | |
| Davide Pesavento | 399f0b9 | 2020-04-17 18:31:26 -0400 | [diff] [blame^] | 27 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU Lesser General Public License](LICENSE.md) for more details. |