io.joynr.messaging

Class MessagingQos

java.lang.Object

io.joynr.messaging.MessagingQos

public class MessagingQos
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TTL
static Map<String,String>	DEFAULTQOS

Constructor Summary

Constructors

Constructor and Description
MessagingQos() MessagingQos with default values
MessagingQos(boolean encrypt)
MessagingQos(long ttl_ms)
MessagingQos(long ttl_ms, boolean encrypt)
MessagingQos(long ttl_ms, MessagingQosEffort effort)
MessagingQos(long ttl_ms, MessagingQosEffort effort, boolean encrypt)
MessagingQos(long ttl_ms, MessagingQosEffort effort, Map<String,String> customHeaders, boolean compress)
MessagingQos(MessagingQos src)
MessagingQos(MessagingQosEffort effort)
MessagingQos(MessagingQosEffort effort, boolean encrypt)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Check for equality
boolean	getCompress() Gets Compress
Map<String,String>	getCustomMessageHeaders()
MessagingQosEffort	getEffort()
boolean	getEncrypt() Gets Encrypt
long	getRoundTripTtl_ms()
int	hashCode() Calculate code for hashing based on member contents
void	putAllCustomMessageHeaders(Map<String,String> newCustomHeaders)
void	putCustomMessageHeader(String key, String value)
void	setCompress(boolean compress)
void	setEffort(MessagingQosEffort effort)
void	setEncrypt(boolean encrypt)
void	setTtl_ms(long ttl_ms)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TTL

public static final int DEFAULT_TTL

See Also:

Constant Field Values

DEFAULTQOS

public static final Map<String,String> DEFAULTQOS

Constructor Detail

MessagingQos

public MessagingQos(MessagingQos src)

MessagingQos

public MessagingQos()

MessagingQos with default values

MessagingQos

public MessagingQos(long ttl_ms)

Parameters:

ttl_ms - Roundtrip timeout for rpc requests.

MessagingQos

public MessagingQos(long ttl_ms,
                    MessagingQosEffort effort)

Parameters:

ttl_ms - Roundtrip timeout for rpc requests.

effort - the effort to expend in ensuring message delivery.

MessagingQos

public MessagingQos(MessagingQosEffort effort)

Parameters:

effort - the effort to expend in ensuring message delivery.

MessagingQos

public MessagingQos(MessagingQosEffort effort,
                    boolean encrypt)

Parameters:

effort - the effort to expend in ensuring message delivery.

encrypt - specifies, whether messages will be sent encrypted

MessagingQos

public MessagingQos(boolean encrypt)

Parameters:

encrypt - specifies, whether messages will be sent encrypted

MessagingQos

public MessagingQos(long ttl_ms,
                    boolean encrypt)

Parameters:

ttl_ms - Roundtrip timeout for rpc requests.

encrypt - specifies, whether messages will be sent encrypted

MessagingQos

public MessagingQos(long ttl_ms,
                    MessagingQosEffort effort,
                    boolean encrypt)

Parameters:

ttl_ms - Roundtrip timeout for rpc requests.

effort - the effort to expend in ensuring message delivery.

encrypt - specifies, whether messages will be sent encrypted

MessagingQos

public MessagingQos(long ttl_ms,
                    MessagingQosEffort effort,
                    Map<String,String> customHeaders,
                    boolean compress)

Parameters:

ttl_ms - Roundtrip timeout for rpc requests.

effort - the effort to expend in ensuring message delivery.

customHeaders - map containing custom headers.
Keys may contain ascii alphanumeric or hyphen.
Values may contain alphanumeric, space, semi-colon, colon, comma, plus, ampersand, question mark, hyphen, dot, star, forward slash and back slash.

compress - specifies, whether messages will be sent compressed

Method Detail

getRoundTripTtl_ms

public long getRoundTripTtl_ms()

setTtl_ms

public void setTtl_ms(long ttl_ms)

Parameters:

ttl_ms - Time to live for a joynr message and the corresponding answer on the complete way from the sender to the receiver and back.

getEffort

public MessagingQosEffort getEffort()

setEffort

public void setEffort(MessagingQosEffort effort)

getEncrypt

public boolean getEncrypt()

Gets Encrypt

Returns:

specifies, whether messages will be sent encrypted

setEncrypt

public void setEncrypt(boolean encrypt)

Parameters:

encrypt - specifies, whether messages will be sent encrypted

getCompress

public boolean getCompress()

Gets Compress

Returns:

specifies, whether messages will be sent compressed

setCompress

public void setCompress(boolean compress)

Parameters:

compress - specifies, whether messages will be sent compressed

putCustomMessageHeader

public void putCustomMessageHeader(String key,
                                   String value)

Parameters:

key - may contain ascii alphanumeric or hyphen.

value - may contain alphanumeric, space, semi-colon, colon, comma, plus, ampersand, question mark, hyphen, dot, star, forward slash and back slash.

Throws:

IllegalArgumentException - if key or value contain any illegal characters

putAllCustomMessageHeaders

public void putAllCustomMessageHeaders(Map<String,String> newCustomHeaders)

Parameters:

newCustomHeaders - map containing custom headers.
Keys may contain ascii alphanumeric or hyphen.
Values may contain alphanumeric, space, semi-colon, colon, comma, plus, ampersand, question mark, hyphen, dot, star, forward slash and back slash.

Throws:

IllegalArgumentException - if key or value contain any illegal characters

getCustomMessageHeaders

public Map<String,String> getCustomMessageHeaders()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Calculate code for hashing based on member contents

Overrides:

hashCode in class Object

Returns:

The calculated hash code

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