- com
- pcbsys
- nirvana
- nAdminAPI
- nMulticastConfiguration
Multicast Configuration class. More...
Public Member Functions | |
| int | getAckWindowSize () |
| Returns the number of packets before sending an ack for received events. More... | |
| String | getAdapter () |
| Returns the adapter that will be bound too for sending multicast. More... | |
| int | getAdapterBufferSize () |
| Returns the size of the adapter buffers to use for both sending and receiving of packets. More... | |
| long | getClientEstablishmentTimeout () |
| The time to wait for a client to establish multicast, if they do not receive any multicast data within this time its assumed they are unable to use multicast. More... | |
| int | getCRCType () |
| Returns the CRC type for guaranteed data integrity, will need to be compared to nMulticastConfiguration.DigestNames. More... | |
| byte | getEncryptionLevel () |
| Returns the encryption level, can be one of nMulticastConfiguration.EncryptionLevel Possible values are: nMulticastConfiguration.EncryptionLevel[0], disables encryption. More... | |
| int | getFlusherInterval () |
| Returns the interval in milliseconds between flushes to the wire for packets. More... | |
| int | getKeepAliveInterval () |
| Returns the interval between keep alive messages sent. More... | |
| int | getMaxOutstandingPackets () |
| Returns the number of allowable unprocessed packets on the receiving side whilst rebuilding missed or out of order packets. More... | |
| byte | getMode () |
| Get the acknowledgement mode. More... | |
| String | getMulticastAddress () |
| Returns the multicast address for this configuration. More... | |
| int | getOutstandingPacketsQueueSize () |
| Gets the allowable size of the outstanding packets queue on the sending side. More... | |
| int | getPacketSize () |
| Maximum data size for a datagram, excludes the datagram headers. More... | |
| int | getPeakRate () |
| Returns the quantity of Nirvana messages per second that when exceeded will enable peak writing mode. More... | |
| int | getRotateEncryptionKeyCount () |
| Returns the packet count to wait before rotating the new encryption key into use. More... | |
| int | getRotateEncryptionKeyTime () |
| Returns the time between encryption key changes. More... | |
| byte | getTrafficClass () |
| Returns the multicast traffic class set for this configuration. More... | |
| short | getTTL () |
| Returns the TTL for the multicast socket, this is the count of hops a datagram can traverse before being dropped. More... | |
| int | getUnAckedWindowSize () |
| Returns the number of outstanding packets allowed to be on the wire without acknowledgement. More... | |
| int | getUniqueSessionIDSize () |
| Returns the length of the session ID used for ensuring integrity and increasing security of data. More... | |
| boolean | isUseForCluster () |
| Gets the flag to allow use of this configuration in a cluster. More... | |
| boolean | isUseForDataGroups () |
| Gets the flag to allow use of this configuration for datagroups. More... | |
| boolean | isUseForStatusUpdates () |
| Gets the flag to allow use of this configuration for status updates used by the nAdminAPI and nRealmNode. More... | |
| nMulticastConfiguration (String multicastAddress, String adapter) throws nAdminIllegalArgumentException | |
| Creates a new multicast configuration with the supplied values. More... | |
| nMulticastConfiguration (String multicastAddress, String adapter, boolean enabled) throws nAdminIllegalArgumentException | |
| Creates a new multicast configuration with the supplied values. More... | |
| void | setAckWindowSize (int ackWindowSize) |
| Sets the number of packets before sending an ack for received events. More... | |
| void | setAdapter (String adapter) throws nAdminIllegalArgumentException |
| Sets the adapter to bind the multicast server to. More... | |
| void | setAdapterBufferSize (int adapterBufferSize) |
| Sets the size of the adapter buffers to use for both sending and receiving of packets. More... | |
| void | setClientEstablishmentTimeout (long clientEstablishmentTimeout) |
| The time to wait for a client to establish multicast, if they do not receive any multicast data within this time its assumed they are unable to use multicast. More... | |
| void | setCRCType (int CRCType) throws nAdminIllegalArgumentException |
| Sets the CRC type for guaranteed data integrity, will need to be compared to nMulticastConfiguration.DigestNames. More... | |
| void | setEncryptionLevel (byte encryptionLevel) throws nAdminIllegalArgumentException |
| Sets the encryption level, can be one of nMulticastConfiguration.EncryptionLevel Possible values are: nMulticastConfiguration.EncryptionLevel[0], disables encryption. More... | |
| void | setFlusherInterval (int flusherInterval) throws nAdminIllegalArgumentException |
| Sets the interval in milliseconds between flushes to the wire for packets. More... | |
| void | setKeepAliveInterval (int keepAliveInterval) throws nAdminIllegalArgumentException |
| Sets the interval between sending of keep alive messages, must be greater than 0. More... | |
| void | setMaxOutstandingPackets (int maxOutstandingPackets) |
| Sets the number of allowable unprocessed packets on the receiving side whilst rebuilding missed or out of order packets. More... | |
| void | setMode (byte mode) |
| Set the acknowledgement mode. More... | |
| void | setMulticastAddress (String multicastAddress) throws nAdminIllegalArgumentException |
| Sets the multicast address for this configuration. More... | |
| void | setOutstandingPacketsQueueSize (int outstandingPacketsQueueSize) |
| Sets the allowable size of the outstanding packets queue on the sending side. More... | |
| void | setPacketSize (int myPacketSize) |
| Maximum data size for a datagram, excludes the datagram headers. More... | |
| void | setPeakRate (int messagesPerSecond) |
| Sets the quantity of Nirvana messages per second that when exceeded will enable peak writing mode. More... | |
| void | setRotateEncryptionKeyCount (int rotateEncryptionKeyCount) |
| Sets the packet count to wait before rotating the new encryption key into use. More... | |
| void | setRotateEncryptionKeyTime (int rotateEncryptionKeyTime) |
| Sets the time between encryption key changes. More... | |
| void | setTrafficClass (byte myQOS) |
| Returns the multicast traffic class set for this configuration. More... | |
| void | setTTL (short myTTL) |
| Sets the TTL for the multicast socket, this is the count of hops a datagram can traverse before being dropped. More... | |
| void | setUnAckedWindowSize (int unAckedWindowSize) |
| Returns the number of outstanding packets allowed to be on the wire without acknowledgement. More... | |
| void | setUniqueSessionIDSize (int myUniqueSessionIDSize) |
| Sets the length of the session ID used for ensuring integrity and increasing security of data. More... | |
| void | setUseForCluster (boolean useForCluster) |
| Sets the flag to allow use of this configuration in a cluster. More... | |
| void | setUseForDataGroups (boolean useForDataGroups) |
| Sets the flag to allow use of this configuration for datagroups. More... | |
| void | setUseForStatusUpdates (boolean useForStatusUpdates) |
| Sets the flag to allow use of this configuration for status updates. More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nBaseInterface | |
| String | getAdapter () |
| Get the adapter that this interface will use. More... | |
| String | getName () |
| Get the name of this interface. More... | |
| int | getPort () |
| Get the port that this interface will bind to at startup. More... | |
| String | getURL () |
| Get the URL that specifies this interface. More... | |
| void | setAutostart (boolean flag) |
| Change the current Autostart status for this interface. More... | |
| boolean | willAutostart () |
| Will this interface automatically be started when the Realm Server starts. More... | |
Multicast Configuration class.
This class exposes the current settings for a multicast protocol configuration on the Nirvana Realm server. It is also used to construct a new configuration on the Realm server, however, the name is only valid when the Realm server has added the interface. For background on what multicast is review these web site http://en.wikipedia.org/wiki/Multicast http://docwiki.cisco.com/wiki/Internet_Protocol_Multicast http://en.wikipedia.org/wiki/IGMP_snooping Multicast address ranges and reserved addresses http://www.iana.org/assignments/multicast-addresses/multicast-addresses.xml http://www.iana.org/assignments/ipv6-multicast-addresses/ipv6-multicast-addresses.xml
| com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.nMulticastConfiguration | ( | String | multicastAddress, |
| String | adapter | ||
| ) | throws nAdminIllegalArgumentException |
Creates a new multicast configuration with the supplied values.
| multicastAddress | The multicast address to use to bind to |
| adapter | the address of the adapter to bind the multicast too. |
| nAdminIllegalArgumentException | if the adapter is null or the port is in an invalid range |
| com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.nMulticastConfiguration | ( | String | multicastAddress, |
| String | adapter, | ||
| boolean | enabled | ||
| ) | throws nAdminIllegalArgumentException |
Creates a new multicast configuration with the supplied values.
| multicastAddress | The multicast address to use to bind to |
| adapter | the address of the adapter to bind the multicast too. |
| enabled | Specifies whether to enable this configuration |
| nAdminIllegalArgumentException | if |
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getAckWindowSize | ( | ) |
Returns the number of packets before sending an ack for received events.
| String com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getAdapter | ( | ) |
Returns the adapter that will be bound too for sending multicast.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getAdapterBufferSize | ( | ) |
Returns the size of the adapter buffers to use for both sending and receiving of packets.
| long com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getClientEstablishmentTimeout | ( | ) |
The time to wait for a client to establish multicast, if they do not receive any multicast data within this time its assumed they are unable to use multicast.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getCRCType | ( | ) |
Returns the CRC type for guaranteed data integrity, will need to be compared to nMulticastConfiguration.DigestNames.
Possible values are: nMulticastConfiguration.DigestNames[0], disables CRC checking. nMulticastConfiguration.DigestNames[1], uses CRC32 for CRC checks. nMulticastConfiguration.DigestNames[2], uses MD5 digest for CRC checks. nMulticastConfiguration.DigestNames[3], uses SHA-5 digest for CRC checks.
| byte com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getEncryptionLevel | ( | ) |
Returns the encryption level, can be one of nMulticastConfiguration.EncryptionLevel Possible values are: nMulticastConfiguration.EncryptionLevel[0], disables encryption.
nMulticastConfiguration.EncryptionLevel[1], uses AES-128 encryption. nMulticastConfiguration.EncryptionLevel[2], uses AES-192 encryption. nMulticastConfiguration.EncryptionLevel[3], uses AES-256 encryption.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getFlusherInterval | ( | ) |
Returns the interval in milliseconds between flushes to the wire for packets.
Higher intervals increase latency and throughput.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getKeepAliveInterval | ( | ) |
Returns the interval between keep alive messages sent.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getMaxOutstandingPackets | ( | ) |
Returns the number of allowable unprocessed packets on the receiving side whilst rebuilding missed or out of order packets.
| byte com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getMode | ( | ) |
Get the acknowledgement mode.
| String com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getMulticastAddress | ( | ) |
Returns the multicast address for this configuration.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getOutstandingPacketsQueueSize | ( | ) |
Gets the allowable size of the outstanding packets queue on the sending side.
These packets are outstanding from receivers to be acknowledge
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getPacketSize | ( | ) |
Maximum data size for a datagram, excludes the datagram headers.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getPeakRate | ( | ) |
Returns the quantity of Nirvana messages per second that when exceeded will enable peak writing mode.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getRotateEncryptionKeyCount | ( | ) |
Returns the packet count to wait before rotating the new encryption key into use.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getRotateEncryptionKeyTime | ( | ) |
Returns the time between encryption key changes.
| byte com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getTrafficClass | ( | ) |
Returns the multicast traffic class set for this configuration.
| short com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getTTL | ( | ) |
Returns the TTL for the multicast socket, this is the count of hops a datagram can traverse before being dropped.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getUnAckedWindowSize | ( | ) |
Returns the number of outstanding packets allowed to be on the wire without acknowledgement.
| int com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.getUniqueSessionIDSize | ( | ) |
Returns the length of the session ID used for ensuring integrity and increasing security of data.
| boolean com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.isUseForCluster | ( | ) |
Gets the flag to allow use of this configuration in a cluster.
| boolean com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.isUseForDataGroups | ( | ) |
Gets the flag to allow use of this configuration for datagroups.
| boolean com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.isUseForStatusUpdates | ( | ) |
Gets the flag to allow use of this configuration for status updates used by the nAdminAPI and nRealmNode.
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setAckWindowSize | ( | int | ackWindowSize | ) |
Sets the number of packets before sending an ack for received events.
| ackWindowSize | ackWindowSize as a int |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setAdapter | ( | String | adapter | ) | throws nAdminIllegalArgumentException |
Sets the adapter to bind the multicast server to.
| adapter | the local adapters IP address for multicast to bind to |
| nAdminIllegalArgumentException | if an invalid address is given |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setAdapterBufferSize | ( | int | adapterBufferSize | ) |
Sets the size of the adapter buffers to use for both sending and receiving of packets.
| adapterBufferSize | int size fo adapter buffer in bytes |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setClientEstablishmentTimeout | ( | long | clientEstablishmentTimeout | ) |
The time to wait for a client to establish multicast, if they do not receive any multicast data within this time its assumed they are unable to use multicast.
| clientEstablishmentTimeout | seconds to wait before removing a client from trying multicast |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setCRCType | ( | int | CRCType | ) | throws nAdminIllegalArgumentException |
Sets the CRC type for guaranteed data integrity, will need to be compared to nMulticastConfiguration.DigestNames.
Possible values are: 0, disables CRC checking. 1, uses CRC32 for CRC checks. 2, uses MD5 digest for CRC checks. 3, uses SHA-5 digest for CRC checks.
| CRCType | one of the DigestNames |
| nAdminIllegalArgumentException | if CRCType outside of possible values |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setEncryptionLevel | ( | byte | encryptionLevel | ) | throws nAdminIllegalArgumentException |
Sets the encryption level, can be one of nMulticastConfiguration.EncryptionLevel Possible values are: nMulticastConfiguration.EncryptionLevel[0], disables encryption.
nMulticastConfiguration.EncryptionLevel[1], uses AES-128 encryption. nMulticastConfiguration.EncryptionLevel[2], uses AES-192 encryption. nMulticastConfiguration.EncryptionLevel[3], uses AES-256 encryption.
| encryptionLevel | one of the above possible values |
| nAdminIllegalArgumentException | if encryptionLevel outside of possible values |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setFlusherInterval | ( | int | flusherInterval | ) | throws nAdminIllegalArgumentException |
Sets the interval in milliseconds between flushes to the wire for packets.
Higher intervals increase latency and throughput. Minimum time between flushes is 1ms
| flusherInterval | the time between flushes. |
| nAdminIllegalArgumentException | if flusherInterval less than 1 |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setKeepAliveInterval | ( | int | keepAliveInterval | ) | throws nAdminIllegalArgumentException |
Sets the interval between sending of keep alive messages, must be greater than 0.
| keepAliveInterval | interval in milliseconds |
| nAdminIllegalArgumentException | if keepAliveInterval less than 1 |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setMaxOutstandingPackets | ( | int | maxOutstandingPackets | ) |
Sets the number of allowable unprocessed packets on the receiving side whilst rebuilding missed or out of order packets.
| maxOutstandingPackets | int |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setMode | ( | byte | mode | ) |
Set the acknowledgement mode.
| mode | the multicast ack mode |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setMulticastAddress | ( | String | multicastAddress | ) | throws nAdminIllegalArgumentException |
Sets the multicast address for this configuration.
| multicastAddress | as a string |
| nAdminIllegalArgumentException | if an invalid multicast address is used |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setOutstandingPacketsQueueSize | ( | int | outstandingPacketsQueueSize | ) |
Sets the allowable size of the outstanding packets queue on the sending side.
These packets are outstanding from receivers to be acknowledge
| outstandingPacketsQueueSize | as a int |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setPacketSize | ( | int | myPacketSize | ) |
Maximum data size for a datagram, excludes the datagram headers.
| myPacketSize | int maximum packet size |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setPeakRate | ( | int | messagesPerSecond | ) |
Sets the quantity of Nirvana messages per second that when exceeded will enable peak writing mode.
| messagesPerSecond | Nirvana messages per second for peak writing. |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setRotateEncryptionKeyCount | ( | int | rotateEncryptionKeyCount | ) |
Sets the packet count to wait before rotating the new encryption key into use.
| rotateEncryptionKeyCount | int |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setRotateEncryptionKeyTime | ( | int | rotateEncryptionKeyTime | ) |
Sets the time between encryption key changes.
| rotateEncryptionKeyTime | int |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setTrafficClass | ( | byte | myQOS | ) |
Returns the multicast traffic class set for this configuration.
| myQOS | multicast traffic class |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setTTL | ( | short | myTTL | ) |
Sets the TTL for the multicast socket, this is the count of hops a datagram can traverse before being dropped.
| myTTL | short count of hops to traverse |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setUnAckedWindowSize | ( | int | unAckedWindowSize | ) |
Returns the number of outstanding packets allowed to be on the wire without acknowledgement.
| unAckedWindowSize | amount of packets on the wire. |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setUniqueSessionIDSize | ( | int | myUniqueSessionIDSize | ) |
Sets the length of the session ID used for ensuring integrity and increasing security of data.
| myUniqueSessionIDSize | the length of the session ID |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setUseForCluster | ( | boolean | useForCluster | ) |
Sets the flag to allow use of this configuration in a cluster.
| useForCluster | boolean indicating whether to use for clustering or not |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setUseForDataGroups | ( | boolean | useForDataGroups | ) |
Sets the flag to allow use of this configuration for datagroups.
| useForDataGroups | boolean indicating whether to use for channels or not |
| void com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration.setUseForStatusUpdates | ( | boolean | useForStatusUpdates | ) |
Sets the flag to allow use of this configuration for status updates.
| useForStatusUpdates | boolean indicating whether to use for channels or not |