Configuration (jRTPS 1.4.0 API)

java.lang.Object
- net.sf.jrtps.Configuration

```
public class Configuration
extends Object
```
Configuration for jRTPS. All the protocol tuning parameters mentioned in specification can be obtained from this class, as well as jRTPS specific configuration parameters.
see 8.4.7.1

Author:

mcr70

Constructor Summary

Constructors
Constructor and Description
`Configuration()` Creates a Configuration from resource named /jrtps.properties
`Configuration(Map<String,Object> properties)` Constructs Configuration with given properties.
`Configuration(String resourceName)` Creates a new Configuration with given resourceName.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAuthenticationPluginName()`
`boolean`	`getBooleanProperty(String key, boolean defltValue)` Gets a named boolean property from configuration.
`int`	`getBufferSize()`
`List<URI>`	`getDiscoveryAnnounceURIs()` Gets the announce URIs for discovery
`List<URI>`	`getDiscoveryListenerURIs()` Gets the listener URIs for discovery
`boolean`	`getEntityListenerHistory()` Gets wheter or not deliver historical data to EntityListeners.
`int`	`getHeartbeatPeriod()` Protocol tuning parameter that allows the RTPS Writer to repeatedly announce the availability of data by sending a Heartbeat Message.
`int`	`getHeartbeatResponseDelay()` Protocol tuning parameter that allows the RTPS Reader to delay the sending of a positive or negative acknowledgment (seeSection 8.4.12.2)
`int`	`getHeartbeatSuppressionDuration()` Protocol tuning parameter that allows the RTPS Reader to ignore HEARTBEATs that arrive 'too soon' after a previous HEARTBEAT was received.
`int`	`getIntProperty(String key, int defltValue)` Gets a named integer property from configuration.
`List<URI>`	`getListenerURIs()` Gets the listener URIs
`int`	`getMessageQueueSize()` Gets the size of message queue.
`int`	`getNackResponseDelay()` Protocol tuning parameter that allows the RTPS Writer to delay the response to a request for data from a negative acknowledgment.
`int`	`getNackSuppressionDuration()` Protocol tuning parameter that allows the RTPS Writer to ignore requests for data from negative acknowledgments that arrive 'too soon' after the corresponding change is sent.
`String`	`getNoOpSharedSecret()`
`PortNumberParameters`	`getPortNumberParameters()` Gets PortNumberParamers from the configuation file.
`String`	`getProperty(String key)` Gets a property with given key.
`String`	`getProperty(String key, String deflt)` Gets a property with given key.
`boolean`	`getPublishBuiltinEntities()` Boolean configuration option.
`boolean`	`getPushMode()` Configures the mode in which the Writer operates.
`String`	`getRTPSProtection()` Gets the protection kind used with RTPS messages,
`int`	`getSEDPDelay()` Gets the delay after announcing SPDP message for discovered participant, and before starting to add matched readers of builtin endpoints.
`Duration`	`getSPDPResendPeriod()` Get the default SPDP announcement rate.
`boolean`	`getWriteCollectionsCoherently()` Gets whether or not udds DataWriter writes collections coherently or not.
`boolean`	`preferMulticast()` get whether or not multicast is preferred.
`void`	`setProperty(String name, String value)` Sets the value of given configuration parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Configuration
```
public Configuration()
```
    Creates a Configuration from resource named /jrtps.properties
  - Configuration
```
public Configuration(Map<String,Object> properties)
```
    Constructs Configuration with given properties.
    
    Parameters:
    
    properties - a Map of properties used to create Configuration
  - Configuration
```
public Configuration(String resourceName)
```
    Creates a new Configuration with given resourceName. If given resourceName is not found, a default Configuration is constructed.
    
    Parameters:
    
    resourceName - name of the resource given to Class.getResourceAsStream(String)
- Method Detail
  - getPushMode
```
public boolean getPushMode()
```
    Configures the mode in which the Writer operates. If pushMode==true, then the Writer will push changes to the reader. If pushMode==false, changes will only be announced via heartbeats and only be sent as response to the request of a reader. Note, that pushMode is applicable only to reliable writers. Best effort writers are always in push mode.
    Default value for pushMode is true
    
    Returns:
    
    pushMode
  - getHeartbeatPeriod
```
public int getHeartbeatPeriod()
```
    Protocol tuning parameter that allows the RTPS Writer to repeatedly announce the availability of data by sending a Heartbeat Message.
    
    Returns:
    
    heartbeat period in milliseconds
  - getNackResponseDelay
```
public int getNackResponseDelay()
```
    Protocol tuning parameter that allows the RTPS Writer to delay the response to a request for data from a negative acknowledgment.
    See chapter 8.4.7.1.1 for default values
    
    Returns:
    
    Nack response delay
  - getNackSuppressionDuration
```
public int getNackSuppressionDuration()
```
    Protocol tuning parameter that allows the RTPS Writer to ignore requests for data from negative acknowledgments that arrive 'too soon' after the corresponding change is sent.
    See chapter 8.4.7.1.1 for default values
    
    Returns:
    
    Nack supression duration
  - getHeartbeatSuppressionDuration
```
public int getHeartbeatSuppressionDuration()
```
    Protocol tuning parameter that allows the RTPS Reader to ignore HEARTBEATs that arrive 'too soon' after a previous HEARTBEAT was received.
    
    Returns:
    
    heartbeat suppression duration in milliseconds
  - getHeartbeatResponseDelay
```
public int getHeartbeatResponseDelay()
```
    Protocol tuning parameter that allows the RTPS Reader to delay the sending of a positive or negative acknowledgment (seeSection 8.4.12.2)
    
    Returns:
    
    heartbeat response delay
  - getBufferSize
```
public int getBufferSize()
```
  - getIntProperty
```
public int getIntProperty(String key,
                          int defltValue)
```
    Gets a named integer property from configuration.
    
    Parameters:
    
    key - Key of the property
    
    defltValue - default value used, if property is not set, or it could not be converted to int
    
    Returns:
    
    integer value
  - getProperty
```
public String getProperty(String key,
                          String deflt)
```
    Gets a property with given key.
    
    Parameters:
    
    key - key of the property
    
    deflt - default value used
    
    Returns:
    
    value with given key, or default value given if key did not exist.
  - setProperty
```
public void setProperty(String name,
                        String value)
```
    Sets the value of given configuration parameter.
    
    Parameters:
    
    name - Name of the configuration parameter
    
    value - Value of the parameter.
  - getProperty
```
public String getProperty(String key)
```
    Gets a property with given key.
    
    Parameters:
    
    key - key of the property
    
    Returns:
    
    value with given key, or null if key did not exist.
  - getBooleanProperty
```
public boolean getBooleanProperty(String key,
                                  boolean defltValue)
```
    Gets a named boolean property from configuration.
    
    Parameters:
    
    key - Key of the property
    
    defltValue - default value used, if property is not set, or it could not be converted to boolean
    
    Returns:
    
    boolean value
  - getSPDPResendPeriod
```
public Duration getSPDPResendPeriod()
```
    Get the default SPDP announcement rate. see 9.6.1.4.2 Default announcement rate
    
    Returns:
    
    resend period.
  - getMessageQueueSize
```
public int getMessageQueueSize()
```
    Gets the size of message queue.
    
    Returns:
    
    queue size
  - preferMulticast
```
public boolean preferMulticast()
```
    get whether or not multicast is preferred.
    
    Returns:
    
    true or false
  - getPublishBuiltinEntities
```
public boolean getPublishBuiltinEntities()
```
    Boolean configuration option. If true, builtin data for builtin entities is published.
    
    Returns:
    
    true or false
  - getPortNumberParameters
```
public PortNumberParameters getPortNumberParameters()
```
    Gets PortNumberParamers from the configuation file. If a port number parameter is missing, its default value is set into returned PortNumberParameters
    
    Returns:
    
    PortNumberParameters
  - getListenerURIs
```
public List<URI> getListenerURIs()
```
    Gets the listener URIs
    
    Returns:
    
    Listener URIs
  - getDiscoveryListenerURIs
```
public List<URI> getDiscoveryListenerURIs()
```
    Gets the listener URIs for discovery
    
    Returns:
    
    Listener URIs
  - getDiscoveryAnnounceURIs
```
public List<URI> getDiscoveryAnnounceURIs()
```
    Gets the announce URIs for discovery
    
    Returns:
    
    Announce URIs
  - getWriteCollectionsCoherently
```
public boolean getWriteCollectionsCoherently()
```
    Gets whether or not udds DataWriter writes collections coherently or not.
    
    Returns:
    
    true, if writer writes collections coherently
  - getSEDPDelay
```
public int getSEDPDelay()
```
    Gets the delay after announcing SPDP message for discovered participant, and before starting to add matched readers of builtin endpoints. I.e. delay before announcing local endpoints to remote readers.
    
    Returns:
    
    delay in millis
  - getAuthenticationPluginName
```
public String getAuthenticationPluginName()
```
  - getNoOpSharedSecret
```
public String getNoOpSharedSecret()
```
  - getRTPSProtection
```
public String getRTPSProtection()
```
    Gets the protection kind used with RTPS messages,
    
    Returns:
    
    protection kind
  - getEntityListenerHistory
```
public boolean getEntityListenerHistory()
```
    Gets wheter or not deliver historical data to EntityListeners.
    
    Returns:
    
    true or false

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Configuration

Configuration

Method Detail

getPushMode

getHeartbeatPeriod

getNackResponseDelay

getNackSuppressionDuration

getHeartbeatSuppressionDuration

getHeartbeatResponseDelay

getBufferSize

getIntProperty

getProperty

setProperty

getProperty

getBooleanProperty

getSPDPResendPeriod

getMessageQueueSize

preferMulticast

getPublishBuiltinEntities

getPortNumberParameters

getListenerURIs

getDiscoveryListenerURIs

getDiscoveryAnnounceURIs

getWriteCollectionsCoherently

getSEDPDelay

getAuthenticationPluginName

getNoOpSharedSecret

getRTPSProtection

getEntityListenerHistory