Type alias DmrClusterLink

DmrClusterLink: {
    authenticationBasicPassword?: string;
    authenticationScheme?: DmrClusterLink.authenticationScheme;
    clientProfileQueueControl1MaxDepth?: number;
    clientProfileQueueControl1MinMsgBurst?: number;
    clientProfileQueueDirect1MaxDepth?: number;
    clientProfileQueueDirect1MinMsgBurst?: number;
    clientProfileQueueDirect2MaxDepth?: number;
    clientProfileQueueDirect2MinMsgBurst?: number;
    clientProfileQueueDirect3MaxDepth?: number;
    clientProfileQueueDirect3MinMsgBurst?: number;
    clientProfileQueueGuaranteed1MaxDepth?: number;
    clientProfileQueueGuaranteed1MinMsgBurst?: number;
    clientProfileTcpCongestionWindowSize?: number;
    clientProfileTcpKeepaliveCount?: number;
    clientProfileTcpKeepaliveIdleTime?: number;
    clientProfileTcpKeepaliveInterval?: number;
    clientProfileTcpMaxSegmentSize?: number;
    clientProfileTcpMaxWindowSize?: number;
    dmrClusterName?: string;
    egressFlowWindowSize?: number;
    enabled?: boolean;
    initiator?: initiator;
    queueDeadMsgQueue?: string;
    queueEventSpoolUsageThreshold?: EventThreshold;
    queueMaxDeliveredUnackedMsgsPerFlow?: number;
    queueMaxMsgSpoolUsage?: number;
    queueMaxRedeliveryCount?: number;
    queueMaxTtl?: number;
    queueRejectMsgToSenderOnDiscardBehavior?: DmrClusterLink.queueRejectMsgToSenderOnDiscardBehavior;
    queueRespectTtlEnabled?: boolean;
    remoteNodeName?: string;
    span?: span;
    transportCompressedEnabled?: boolean;
    transportTlsEnabled?: boolean;
}

Type declaration

  • Optional authenticationBasicPassword?: string

    The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "".

  • Optional authenticationScheme?: DmrClusterLink.authenticationScheme

    The authentication scheme to be used by the Link which initiates connections to the remote node. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "basic". The allowed values and their meaning are:

    "basic" - Basic Authentication Scheme (via username and password).
"client-certificate" - Client Certificate Authentication Scheme (via certificate file or content).
  • Optional clientProfileQueueControl1MaxDepth?: number

    The maximum depth of the "Control 1" (C-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

  • Optional clientProfileQueueControl1MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Control 1" (C-1) priority queue, regardless of the clientProfileQueueControl1MaxDepth value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

  • Optional clientProfileQueueDirect1MaxDepth?: number

    The maximum depth of the "Direct 1" (D-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

  • Optional clientProfileQueueDirect1MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Direct 1" (D-1) priority queue, regardless of the clientProfileQueueDirect1MaxDepth value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

  • Optional clientProfileQueueDirect2MaxDepth?: number

    The maximum depth of the "Direct 2" (D-2) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

  • Optional clientProfileQueueDirect2MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Direct 2" (D-2) priority queue, regardless of the clientProfileQueueDirect2MaxDepth value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

  • Optional clientProfileQueueDirect3MaxDepth?: number

    The maximum depth of the "Direct 3" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

  • Optional clientProfileQueueDirect3MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the clientProfileQueueDirect3MaxDepth value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 4.

  • Optional clientProfileQueueGuaranteed1MaxDepth?: number

    The maximum depth of the "Guaranteed 1" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 20000.

  • Optional clientProfileQueueGuaranteed1MinMsgBurst?: number

    The number of messages that are always allowed entry into the "Guaranteed 1" (G-3) priority queue, regardless of the clientProfileQueueGuaranteed1MaxDepth value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 255.

  • Optional clientProfileTcpCongestionWindowSize?: number

    The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 2.

  • Optional clientProfileTcpKeepaliveCount?: number

    The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 5.

  • Optional clientProfileTcpKeepaliveIdleTime?: number

    The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 3.

  • Optional clientProfileTcpKeepaliveInterval?: number

    The amount of time between TCP keepalive retransmissions when no acknowledgement is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1.

  • Optional clientProfileTcpMaxSegmentSize?: number

    The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1460.

  • Optional clientProfileTcpMaxWindowSize?: number

    The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 256.

  • Optional dmrClusterName?: string

    The name of the Cluster.

  • Optional egressFlowWindowSize?: number

    The number of outstanding guaranteed messages that can be sent over the Link before acknowledgement is received by the sender. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 255.

  • Optional enabled?: boolean

    Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

  • Optional initiator?: initiator

    The initiator of the Link's TCP connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "lexical". The allowed values and their meaning are:

    "lexical" - The "higher" node-name initiates.
"local" - The local node initiates.
"remote" - The remote node initiates.
  • Optional queueDeadMsgQueue?: string

    The name of the Dead Message Queue (DMQ) used by the Queue for discarded messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "#DEAD_MSG_QUEUE".

  • Optional queueEventSpoolUsageThreshold?: EventThreshold
  • Optional queueMaxDeliveredUnackedMsgsPerFlow?: number

    The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 1000000.

  • Optional queueMaxMsgSpoolUsage?: number

    The maximum message spool usage by the Queue (quota), in megabytes (MB). Changes to this attribute are synchronized to HA mates via config-sync. The default value is 800000.

  • Optional queueMaxRedeliveryCount?: number

    The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0.

  • Optional queueMaxTtl?: number

    The maximum time in seconds a message can stay in the Queue when queueRespectTtlEnabled is true. A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the queueMaxTtl configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates via config-sync. The default value is 0.

  • Optional queueRejectMsgToSenderOnDiscardBehavior?: DmrClusterLink.queueRejectMsgToSenderOnDiscardBehavior

    Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "always". The allowed values and their meaning are:

    "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
"when-queue-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.
"never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.
  • Optional queueRespectTtlEnabled?: boolean

    Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

  • Optional remoteNodeName?: string

    The name of the node at the remote end of the Link.

  • Optional span?: span

    The span of the Link, either internal or external. Internal Links connect nodes within the same Cluster. External Links connect nodes within different Clusters. Changes to this attribute are synchronized to HA mates via config-sync. The default value is "external". The allowed values and their meaning are:

    "internal" - Link to same cluster.
"external" - Link to other cluster.
  • Optional transportCompressedEnabled?: boolean

    Enable or disable compression on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

  • Optional transportTlsEnabled?: boolean

    Enable or disable encryption (TLS) on the Link. Changes to this attribute are synchronized to HA mates via config-sync. The default value is false.

Settings

Member Visibility

Theme