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

    {

        network

        {

            name /ndn             ; name prefix of the network router belongs to

        }                         ; must be in ndn URI format

        site-name

        {

            name /memphis.edu     ; name prefix of the site name router belongs to

        }                         ; must be in ndn URI format

        router-name

        {

            name /cs/pollux       ; name prefix of the router

        }                         ; must be in ndn URI format

    }

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

    hello

    {

    ; 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

           host cs.castor.memphis.edu      ; hostname or ip address of neighbor router

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

       }

    ; interest-retry command is used to configure the interval of hello interest and number

    ; of retry interests before a router gives up in case of interest timed out

       interest-retry

       {

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

                            ; valid values 1-10

           interval  10     ; interest sending interval in seconds. Default value 1

                            ; valid values 1-15

       }

    }

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

    ; synchronization with neighbors in the network

    synchronization

    {

    ;

        sync-prefix

        {

            name /ndn/nlsr/sync    ;

        }

        lsa-refresh-time

        {

            seconds 1800           ;

        }

    }

    ; the face_system section defines what faces and channels are created

    face_system

    {

      ; the unix section contains settings of UNIX stream faces and channels

      unix

      {

        listen yes ; set to 'no' to disable UNIX stream listener, default 'yes'

        path /var/run/nfd.sock ; UNIX stream listener path

      }

      ; the tcp section contains settings of TCP faces and channels

      tcp

      {

        listen yes ; set to 'no' to disable TCP listener, default 'yes'

        port 6363 ; TCP listener port number

      }

      ; the udp section contains settings of UDP faces and channels

      udp

      {

        port 6363 ; UDP unicast port number

        idle_timeout 30 ; idle time (seconds) before closing a UDP unicast face

        keep_alive_interval 25; interval (seconds) between keep-alive refreshes

        ; NFD creates one UDP multicast face per NIC

        mcast yes ; set to 'no' to disable UDP multicast, default 'yes'

        mcast_port 56363 ; UDP multicast port number

        mcast_group 224.0.23.170 ; UDP multicast group (IPv4 only)

      }

      ; the ether section contains settings of Ethernet faces and channels

      ether

      {

        ; NFD creates one Ethernet multicast face per NIC

        mcast yes ; set to 'no' to disable Ethernet multicast, default 'yes'

        mcast_group 01:00:5E:00:17:AA ; Ethernet multicast group

      }

    }