joynr.types

Class DiscoveryQos

java.lang.Object

joynr.types.DiscoveryQos

All Implemented Interfaces:

JoynrType, Serializable

public class DiscoveryQos
extends Object
implements Serializable, JoynrType

Discovery quality of service settings

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAJOR_VERSION
static int	MINOR_VERSION

Constructor Summary

Constructors

Constructor and Description
DiscoveryQos() Default Constructor
DiscoveryQos(DiscoveryQos discoveryQosObj) Copy constructor
DiscoveryQos(Long cacheMaxAge, Long discoveryTimeout, DiscoveryScope discoveryScope, Boolean providerMustSupportOnChange) Parameterized constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Check for equality
Long	getCacheMaxAge() Gets CacheMaxAge
DiscoveryScope	getDiscoveryScope() Gets DiscoveryScope
Long	getDiscoveryTimeout() Gets DiscoveryTimeout
Boolean	getProviderMustSupportOnChange() Gets ProviderMustSupportOnChange
int	hashCode() Calculate code for hashing based on member contents
void	setCacheMaxAge(Long cacheMaxAge) Sets CacheMaxAge
void	setDiscoveryScope(DiscoveryScope discoveryScope) Sets DiscoveryScope
void	setDiscoveryTimeout(Long discoveryTimeout) Sets DiscoveryTimeout
void	setProviderMustSupportOnChange(Boolean providerMustSupportOnChange) Sets ProviderMustSupportOnChange
String	toString() Stringifies the class

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAJOR_VERSION

public static final int MAJOR_VERSION

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

See Also:

Constant Field Values

Constructor Detail

DiscoveryQos

public DiscoveryQos()

Default Constructor

DiscoveryQos

public DiscoveryQos(DiscoveryQos discoveryQosObj)

Copy constructor

Parameters:

discoveryQosObj - reference to the object to be copied

DiscoveryQos

public DiscoveryQos(Long cacheMaxAge,
                    Long discoveryTimeout,
                    DiscoveryScope discoveryScope,
                    Boolean providerMustSupportOnChange)

Parameterized constructor

Parameters:

cacheMaxAge - The maximum age of a cached entry in milliseconds

discoveryTimeout - Discovery TTL

discoveryScope - The discovery scope: at which level (GLOBAL/LOCAL) should providers be searched.

providerMustSupportOnChange - True, if the provider is required to support the OnChange publication

Method Detail

getCacheMaxAge

public Long getCacheMaxAge()

Gets CacheMaxAge

Returns:

The maximum age of a cached entry in milliseconds

setCacheMaxAge

public void setCacheMaxAge(Long cacheMaxAge)

Sets CacheMaxAge

Parameters:

cacheMaxAge - The maximum age of a cached entry in milliseconds

getDiscoveryTimeout

public Long getDiscoveryTimeout()

Gets DiscoveryTimeout

Returns:

Discovery TTL

setDiscoveryTimeout

public void setDiscoveryTimeout(Long discoveryTimeout)

Sets DiscoveryTimeout

Parameters:

discoveryTimeout - Discovery TTL

getDiscoveryScope

public DiscoveryScope getDiscoveryScope()

Gets DiscoveryScope

Returns:

The discovery scope: at which level (GLOBAL/LOCAL) should providers be searched.

setDiscoveryScope

public void setDiscoveryScope(DiscoveryScope discoveryScope)

Sets DiscoveryScope

Parameters:

discoveryScope - The discovery scope: at which level (GLOBAL/LOCAL) should providers be searched.

getProviderMustSupportOnChange

public Boolean getProviderMustSupportOnChange()

Gets ProviderMustSupportOnChange

Returns:

True, if the provider is required to support the OnChange publication

setProviderMustSupportOnChange

public void setProviderMustSupportOnChange(Boolean providerMustSupportOnChange)

Sets ProviderMustSupportOnChange

Parameters:

providerMustSupportOnChange - True, if the provider is required to support the OnChange publication

toString

public String toString()

Stringifies the class

Overrides:

toString in class Object

Returns:

stringified class content

equals

public boolean equals(Object obj)

Check for equality

Overrides:

equals in class Object

Parameters:

obj - Reference to the object to compare to

Returns:

true, if objects are equal, false otherwise

hashCode

public int hashCode()

Calculate code for hashing based on member contents

Overrides:

hashCode in class Object

Returns:

The calculated hash code