Interface Options

PyRepoClient constructor options.

interface Options {
    checkInterval?: number;
    combineRange?: boolean;
    commandLengthLimit?: number;
    commandTimeout?: number;
    cpOpts?: ConsumerOptions & ProducerOptions;
    endpoint?: Endpoint;
    notifyInterestLifetime?: number;
    pubAnnouncement?: false | Name;
    pubFwHint?: Name;
    pubPrefix?: Name;
    pubSigner?: Signer;
    repoPrefix: Name;
}

Hierarchy (view full)

Properties

checkInterval? combineRange? commandLengthLimit? commandTimeout? cpOpts? endpoint? notifyInterestLifetime? pubAnnouncement? pubFwHint? pubPrefix? pubSigner? repoPrefix

Properties

Optional checkInterval

checkInterval?: number

How often to check command progress in milliseconds.

Default Value

1 second

Optional combineRange

combineRange?: boolean

If true, attempt to combine consecutive parameters into RangeParam.

Default Value

false

Optional commandLengthLimit

commandLengthLimit?: number

Maximum TLV-LENGTH of each RepoCommandParam.

Default Value

6144

Optional commandTimeout

commandTimeout?: number

Maximum duration of each command in milliseconds.

Default Value

60 seconds

Optional cpOpts

cpOpts?: ConsumerOptions & ProducerOptions

Consumer and producer options.

Remarks

  • .fw may be specified.
  • Most other fields are overridden.

Optional endpoint

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .cpOpts.

Optional notifyInterestLifetime

notifyInterestLifetime?: number

InterestLifetime of notify Interests.

Optional pubAnnouncement

pubAnnouncement?: false | Name

Prefix announcement to receive msg Interests.

Default Value

.pubFwHint ?? .pubPrefix

Optional pubFwHint

pubFwHint?: Name

Forwarding hint of the local application.

Optional pubPrefix

pubPrefix?: Name

Name prefix of the local application.

Default Value

"/localhost" + random-suffix

Optional pubSigner

pubSigner?: Signer

Key to sign publications.

Default Value

digestSigning

Remarks

This key should be trusted to sign objects under pubPrefix. This may overridden on a per-publication basis by PublicationCallback returning Data.

repoPrefix

repoPrefix: Name

Name prefix of the repo instance.

Remarks

This corresponds to ndn-python-repo.conf .repo_config.repo_name key.

Settings

Member Visibility

Theme

On This Page

checkIntervalcombineRangecommandLengthLimitcommandTimeoutcpOptsendpointnotifyInterestLifetimepubAnnouncementpubFwHintpubPrefixpubSignerrepoPrefix