NLSR

## Configuration File Format

NLSR is configured using an [INFO file](http://www.boost.org/doc/libs/1_42_0/doc/html/boost_propertytree/parsers.html#boost_propertytree.parsers.info_parser).

## Example configuration

    ; the router section contains the setting of network, site name 

    ; and router name which all together makes router-prefix

    router

    {

    ; mandatory configuration command section

        network /ndn         ; name of the network the router belongs to in ndn URI format

        site /memphis.edu    ; name of the site the router belongs to in ndn URI format

        router /cs/pollux    ; name of the network the router belongs to in ndn URI format

    }

    ; the hello section describes the configuration settings for NLSR hello protocol

    hello

    {

    ; in case hello interest timed out, router will try 'retrials' times at 'interval' seconds

    ; interval before giving up for any neighbors (deciding link is down)     

       retrials 3                          ; interest retry number in integer. Default value 3

                                           ; valid values 1-10

       interval                            ; interest sending interval in seconds. Default value 1

                                           ; valid values 1-15

    ; neighbor command is used to configure router's neighbor. Each neighbor will need

    ; one block of neighbor command

       neighbor

       {

           name /ndn/memphis.edu/cs/castor ; name prefix of the neighbor router consists

                                           ; of network, site-name and router-name

           face-id  10                     ; face id of the face connected to the neighbor

           link-cost 20.6                  ; cost of the connecting link to neighbor

       }

    }

    ; the synchronization section contains all the configuration settings for router's update

    ; synchronization with neighbors in the network

    synchronization

    {

    ; all routers in the network must have same sync-prefix. Routers synchronizes routing updates

    ; in this prefix across the network. This prefix is routable to each neighbor from every router

        sync-prefix /ndn/nlsr/sync ; name in URI format. Default value /ndn/nlsr/sync

    ; lsa-refresh-time is the time in seconds, after which router will refresh its LSAs

        lsa-refresh-time 1800      ; default value 1800. Valid values 240-7200

    }

    ; the hyperbolic section contains the configuration settings of enabling a router to calculate

    ; routing table using [hyperbolic routing table calculation](http://arxiv.org/abs/0805.1266) method

    hyperbolic

    {

    ; commands in this section follows a strict order

    ; the switch is used to set hyperbolic routing calculation in NLSR

        state off              ; default value 'off', set value 'on' to enable hyperbolic routing table 

                               ; calculation which turns link state routing 'off'. set value to 'dry-run"

                               ; to test hyperbolic routing and compare with link state routing.

        radius   123.456       ; radius of the router in hyperbolic coordinate system

        angle    1.45          ; angle of the router in hyperbolic coordinate system

    }

    ; the fib section is used to configure fib entry's type to ndn FIB updated by NLSR

    fib

    {

    ; the tunnel configuration is used to set the tunnel type of the FIB entries by NLSR

        tunnel-type udp          ; default tunnel type is 'udp', set value to 'tcp' for TCP tunnel

    ; the max-faces-per-prefix is used to limit the number of faces for each name prefixes

    ; by NLSR in ndn FIB

        max-faces-per-prefix 3   ; default value 0. Valid value 0-60. By default (value 0) NLSR adds

                                 ; all available faces for each reachable name prefixes in NDN FIB

    }

    ; the advertising section contains the configuration settings of the name prefixes 

    ; hosted by this router

    advertising

    {

    ; the ndnname is used to advertised name from the router. To advertise each name prefix

    ; configure one block of ndnname configuration command for every name prefix.

        prefix /ndn/edu/memphis/cs/netlab           ; name in ndn URI format

        prefix /ndn/edu/memphis/sports/basketball 

    }