Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet

java.lang.Object
        com.ibm.broker.config.proxy.BrokerProxy.MulticastParameterSet

public static class BrokerProxy.MulticastParameterSet
extends Object

A small data structure that represents the set of parameters required to enable multicast on this broker.

Field Index
Field Description
multicastBackoffTimeMillis [ADVANCED] NACK suppression parameter.
multicastDataPort The UDP data port of which multicast packets will be transmitted and received.
multicastDefaultQOS Default QOS.
multicastDefaultSecurity Default security mode.
multicastEnabled The switch for turning multicast support on or off.
multicastHeartbeatTimeoutSec The transmitter periodically transmits a heartbeat packet to let receivers know there is still an active stream.
multicastHistoryCleaningTimeSec [ADVANCED] The period of retransmission buffer cleaning, in secs.
multicastIPv4Interface The name/address of the network interface over which IPv4 multicast packets will be transmitted.
multicastIPv6Interface This parameter is reserved for future use.
multicastLimitTransRate [ADVANCED] Denotes whether congestion control is enabled by the broker.
multicastMaximumIPv4Address The highest IPv4 address that the broker could automatically allocate for multicast.
multicastMaximumIPv6Address This parameter is reserved for future use.
multicastMaxKeyAge [ADVANCED] The maximum age of a key (in minutes).
multicastMaxMemoryAllowedKBytes The value of the multicast maximum memory allowed parameter.
multicastMcastSocketTTL Time to Live of network packets.
multicastMinimalHistoryKBytes [ADVANCED] The minimum size (in Kb) of a buffer allocated for storing the transmitted packets, kept for possible future repair requests from the receivers.
multicastMinimumIPv4Address The lowest IP address that the broker could automatically allocate for multicast.
multicastMinimumIPv6Address This parameter is reserved for future use.
multicastNACKAccumulationTimeMillis [ADVANCED] The time (in milliseconds) NACKs are aggregated in the broker before repairs are sent.
multicastNACKCheckPeriodMillis [ADVANCED] The time between periodic checks of reception status and sequence gap detection for NACK building.
multicastOverlappingTopicBehaviour In the case where a subscription is made to a TSP where at a lower level in the hierarchy the following course of action would be applied.
multicastPacketBuffers [ADVANCED] Number of memory buffers created upon start up for packet reception.
multicastPacketSizeBytes Size of multicast packets.
multicastProtocolType Denotes the type of multicast protocol in use by the broker.
multicastSocketBufferSizeKBytes [ADVANCED] Size of socket receiver buffer, in Kb.
multicastTransRateLimitKbps [ADVANCED] This limits the overall transmission rate in kilobits per second.
Constructor Index
Constructor Description
BrokerProxy.MulticastParameterSet()  

Fields

multicastBackoffTimeMillis

public int multicastBackoffTimeMillis

[ADVANCED] NACK suppression parameter. Specifies the maximal time receiver waits listening to other's NACKs before sending its own. Set to 0 to disable suppression mechanism. Valid values are 0 to 1000.

multicastDataPort

public int multicastDataPort

The UDP data port of which multicast packets will be transmitted and received.

multicastDefaultQOS

public boolean multicastDefaultQOS

Default QOS. Reliable or unreliable mode of multicast transmission. If and only if this parameter is true, transmission will be reliable.

multicastDefaultSecurity

public boolean multicastDefaultSecurity

Default security mode. Secure or unsecure. If and only if this parameter is true, default security will be 'secure'.

multicastEnabled

public boolean multicastEnabled

The switch for turning multicast support on or off.

multicastHeartbeatTimeoutSec

public int multicastHeartbeatTimeoutSec

The transmitter periodically transmits a heartbeat packet to let receivers know there is still an active stream. This timeout setting is used to determine when to consider a multicast stream defunct.

multicastHistoryCleaningTimeSec

public int multicastHistoryCleaningTimeSec

[ADVANCED] The period of retransmission buffer cleaning, in secs. Valid values are 1 to 20. This parameter is only used by v5.x brokers.

multicastIPv4Interface

public java.lang.String multicastIPv4Interface

The name/address of the network interface over which IPv4 multicast packets will be transmitted.

multicastIPv6Interface

public java.lang.String multicastIPv6Interface

This parameter is reserved for future use. Do not set it.

multicastLimitTransRate

public java.lang.String multicastLimitTransRate

[ADVANCED] Denotes whether congestion control is enabled by the broker. A value that can be enabled to enable the network and routers to continue to process TCP/IP and other traffic instead of being flooded. If and only if this parameter is true, congestion control is enabled. Valid values are:

multicastMaximumIPv4Address

public java.lang.String multicastMaximumIPv4Address

The highest IPv4 address that the broker could automatically allocate for multicast. The address must be between 224.0.0.1 and 239.255.255.255, and logically the same or less than the value of 'multicastMinimumIPv4Address' at the time the properties are set in the broker.

multicastMaximumIPv6Address

public java.lang.String multicastMaximumIPv6Address

This parameter is reserved for future use. Do not set it.

multicastMaxKeyAge

public int multicastMaxKeyAge

[ADVANCED] The maximum age of a key (in minutes). Its value must be at least 1.

multicastMaxMemoryAllowedKBytes

public int multicastMaxMemoryAllowedKBytes

The value of the multicast maximum memory allowed parameter. Valid values are any positive integer. The default value is 262144.

multicastMcastSocketTTL

public int multicastMcastSocketTTL

Time to Live of network packets. This parameter determines the number of routers a multicast packet may pass thorough. Valid values are from 0 to 255.

multicastMinimalHistoryKBytes

public int multicastMinimalHistoryKBytes

[ADVANCED] The minimum size (in Kb) of a buffer allocated for storing the transmitted packets, kept for possible future repair requests from the receivers. This memory is shared by all reliable topics. Valid values are 1000 to 1000000.

multicastMinimumIPv4Address

public java.lang.String multicastMinimumIPv4Address

The lowest IP address that the broker could automatically allocate for multicast. The address must be between 224.0.0.1 and 239.255.255.255, and logically the same or greater than the value of 'multicastMaximumIPv4Address' at the time the properties are set in the broker.

multicastMinimumIPv6Address

public java.lang.String multicastMinimumIPv6Address

This parameter is reserved for future use. Do not set it.

multicastNACKAccumulationTimeMillis

public int multicastNACKAccumulationTimeMillis

[ADVANCED] The time (in milliseconds) NACKs are aggregated in the broker before repairs are sent. Valid values are 50 to 1000.

multicastNACKCheckPeriodMillis

public int multicastNACKCheckPeriodMillis

[ADVANCED] The time between periodic checks of reception status and sequence gap detection for NACK building. Valid values are 10 to 1000.

multicastOverlappingTopicBehaviour

public int multicastOverlappingTopicBehaviour

In the case where a subscription is made to a TSP where at a lower level in the hierarchy the following course of action would be applied. If 'Accept', a matching multicast subscription is accepted and all publications matching the TSP except those excluded will be multicasted. If 'Reject', a multicast subscription to a TSP with lower level exclusions will be rejected. If 'Revert', the subscription will revert to standard unicast behaviour. Equally, if a TSP is disabled but this setting is 'Revert', a disabled multicast connection can revert to standard unicast behaviour.

Valid values are: Accept: 0 Reject: 1 Revert: 2

multicastPacketBuffers

public int multicastPacketBuffers

[ADVANCED] Number of memory buffers created upon start up for packet reception. Valid values are 1 to 5000.

multicastPacketSizeBytes

public int multicastPacketSizeBytes

Size of multicast packets. In practice this should be set at the MTU of the network minus the size of RMM/PGM packet headers. Valid values are from 500 to 32000.

multicastProtocolType

public java.lang.String multicastProtocolType

Denotes the type of multicast protocol in use by the broker. Valid values are:

multicastSocketBufferSizeKBytes

public int multicastSocketBufferSizeKBytes

[ADVANCED] Size of socket receiver buffer, in Kb. Valid values are 65 to 10000.

multicastTransRateLimitKbps

public int multicastTransRateLimitKbps

[ADVANCED] This limits the overall transmission rate in kilobits per second. This parameter is only effective if multicastLimitTransRate is not disabled. A TokenBucket traffic shaping mechanism maintains this rate limit. In practice, this parameter should not exceed the capabilities of the machine or network or this setting will never be reached. Valid values are 10 to 1000000.

Constructors

BrokerProxy.MulticastParameterSet

public BrokerProxy.MulticastParameterSet() 

Class Hierarchy All Classes All Fields and Methods