Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrimaryInitiator

A primary initiator.

This type makes a connection from a primary server (cluster) to a secondary server (or all secondary cluster members) with a SecondaryAcceptor of the same name.

Use a PrimaryInitiatorBuilder to create an instance of this type.

Hierarchy

Index

Properties

connectionOptions

connectionOptions: ConnectionOptions

Options used for connection to the remote server.

deprecated

since 6.9

For backwards compatibility this property is retained for secondary initiator compatibility but will be removed at a future release.

Optional connector

connector: undefined | string

The connector that the primary initiator will use to establish a connection between the secondary server and the primary server.

Optional missingTopicNotificationFilter

missingTopicNotificationFilter: undefined | string

The missing topic notification filter expression or undefined if one has not been specified.

deprecated

since 6.9

For backwards compatibility this property is retained for secondary initiator compatibility but will be removed at a future release.

name

name: string

The name of the remote server.

principal

principal: string

The principal used for connection to the remote server.

deprecated

since 6.9

For backwards compatibility this property is retained for secondary initiator compatibility but will be removed at a future release.

type

The remote server type.

A RemoteServer can be cast to the corresponding sub-type to access all methods, as follows:

Type Type class
SECONDARY_INITIATOR SecondaryInitiator
PRIMARY_INITIATOR PrimaryInitiator
SECONDARY_ACCEPTOR SecondaryAcceptor

url

url: string

The url used for connection to the remote server.

deprecated

since 6.9

For backwards compatibility this property is retained for secondary initiator compatibility but will be removed at a future release.

urls

urls: string[]

The urls for connection to secondary servers.

Methods

getRetryDelay

  • getRetryDelay(): number
  • Gets the interval in milliseconds between connection retries.

    If a primary initiator cannot connect to a secondary server, or loses the connection, this is the amount of time before it will try to connect again.

    Returns number