NDNts
    Preparing search index...

    Type Alias Options

    Options: Except<ControlCommandOptions, "prefix"> & Pick<
        ControlParameters.Fields,
        "origin"
        | "cost"
        | `flag${keyof typeof RouteFlags}`,
    > & {
        PrefixAnn?: typeof PrefixAnn;
        preloadCertName?: Name;
        preloadFromKeyChain?: KeyChain;
        preloadInterestLifetime?: number;
        refreshInterval?: number | false;
        retry?: RetryOptions;
    }

    enableNfdPrefixReg options.

    Type declaration

    • OptionalPrefixAnn?: typeof PrefixAnn

      Opt-in to Prefix Announcement Protocol.

      https://redmine.named-data.net/projects/nfd/wiki/PrefixAnnouncement

      To opt-in, set this field to PrefixAnn imported from this package. Producer must supply Prefix Announcement objects to the FwFace so that they are available for use in the readvertise destinations.

      Currently, the following limitations apply for the Prefix Announcement Protocol:

      • Not all NFD deployments can accept this protocol.
      • You cannot specify Origin, Cost, Flags of the route.
      • The announced prefix will not be further propagated, because NFD considers routes with Origin=65 to be propagable but the route Origin cannot be specified.
    • OptionalpreloadCertName?: Name

      Set to signer name to retrieve and serve certificate chain. If unset, no certificates will be served.

    • OptionalpreloadFromKeyChain?: KeyChain

      Local KeyChain to collect preloaded certificates. If unset, certificates will not be collected from a local KeyChain.

    • OptionalpreloadInterestLifetime?: number

      InterestLifetime for retrieving preloaded certificates.

      1500

    • OptionalrefreshInterval?: number | false

      How often to refresh prefix registration (in milliseconds). Random jitter of ±10% is applied automatically. Set to false disables refreshing.

      300 seconds

      For rib/register command, the ExpirationPeriod is set to 4x of this refresh interval, with a minimum of 60 seconds.

      For rib/announce command, the application must make sure each supplied Prefix Announcement object has an ExpirationPeriod at least 2x of this refresh interval and a ValidityPeriod that extends beyond the anticipated producer runtime.

    • Optionalretry?: RetryOptions

      Retry options for each advertise/withdraw operation.

    Settings

    Member Visibility