Interface Options

PartialPublisher constructor options.

interface Options {
    describe?: string;
    endpoint?: Endpoint;
    helloReplyFreshness?: number;
    p: PSyncPartialPublisher.Parameters;
    pOpts?: ProducerOptions;
    producerBufferLimit?: number;
    signer?: Signer;
    syncPrefix: Name;
    syncReplyFreshness?: number;
}

Properties

describe? endpoint? helloReplyFreshness? p pOpts? producerBufferLimit? signer? syncPrefix syncReplyFreshness?

Properties

Optional describe

describe?: string

Description for debugging purpose.

Default Value

PartialPublisher + syncPrefix

Optional endpoint

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .pOpts.

Optional helloReplyFreshness

helloReplyFreshness?: number

FreshnessPeriod of hello reply Data packet.

Default Value

1000

p

p: PSyncPartialPublisher.Parameters

Algorithm parameters.

Remarks

They must match the subscriber parameters.

Optional pOpts

pOpts?: ProducerOptions

Producer options (advanced).

Remarks

  • .fw is overridden as Options.fw.
  • .describe is overridden as Options.describe.
  • .announcement is overridden.
  • .routeCapture is overridden.
  • .concurrency is overridden.

Optional producerBufferLimit

producerBufferLimit?: number

How many sync reply segmented objects to keep in buffer. This must be a positive integer.

Default Value

32

Optional signer

signer?: Signer

Signer of sync reply Data packets.

Default Value

digestSigning

syncPrefix

syncPrefix: Name

Sync producer prefix.

Optional syncReplyFreshness

syncReplyFreshness?: number

FreshnessPeriod of sync reply Data packet.

Default Value

1000

Settings

Member Visibility

Theme

On This Page

describeendpointhelloReplyFreshnessppOptsproducerBufferLimitsignersyncPrefixsyncReplyFreshness