Type alias MsgVpnDistributedCacheCluster

MsgVpnDistributedCacheCluster: {
    cacheName?: string;
    clusterName?: string;
    deliverToOneOverrideEnabled?: boolean;
    enabled?: boolean;
    eventDataByteRateThreshold?: EventThresholdByValue;
    eventDataMsgRateThreshold?: EventThresholdByValue;
    eventMaxMemoryThreshold?: EventThresholdByPercent;
    eventMaxTopicsThreshold?: EventThresholdByPercent;
    eventRequestQueueDepthThreshold?: EventThresholdByPercent;
    eventRequestRateThreshold?: EventThresholdByValue;
    eventResponseRateThreshold?: EventThresholdByValue;
    globalCachingEnabled?: boolean;
    globalCachingHeartbeat?: number;
    globalCachingTopicLifetime?: number;
    maxMemory?: number;
    maxMsgsPerTopic?: number;
    maxRequestQueueDepth?: number;
    maxTopicCount?: number;
    msgLifetime?: number;
    msgVpnName?: string;
    newTopicAdvertisementEnabled?: boolean;
}

Type declaration

  • Optional cacheName?: string

    The name of the Distributed Cache.

  • Optional clusterName?: string

    The name of the Cache Cluster.

  • Optional deliverToOneOverrideEnabled?: boolean

    Enable or disable deliver-to-one override for the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional enabled?: boolean

    Enable or disable the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional eventDataByteRateThreshold?: EventThresholdByValue
  • Optional eventDataMsgRateThreshold?: EventThresholdByValue
  • Optional eventMaxMemoryThreshold?: EventThresholdByPercent
  • Optional eventMaxTopicsThreshold?: EventThresholdByPercent
  • Optional eventRequestQueueDepthThreshold?: EventThresholdByPercent
  • Optional eventRequestRateThreshold?: EventThresholdByValue
  • Optional eventResponseRateThreshold?: EventThresholdByValue
  • Optional globalCachingEnabled?: boolean

    Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional globalCachingHeartbeat?: number

    The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3.

  • Optional globalCachingTopicLifetime?: number

    The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 3600.

  • Optional maxMemory?: number

    The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 2048.

  • Optional maxMsgsPerTopic?: number

    The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1.

  • Optional maxRequestQueueDepth?: number

    The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 100000.

  • Optional maxTopicCount?: number

    The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 2000000.

  • Optional msgLifetime?: number

    The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional newTopicAdvertisementEnabled?: boolean

    Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

Settings

Member Visibility

Theme