rsb

Class MetaData

java.lang.Object

rsb.MetaData

public class MetaData
extends java.lang.Object

Framework-supplied meta data attached to each event that give information e.g. about timing issues.

Author:

jwienke

Constructor Summary

Constructors

Constructor and Description
MetaData() Creates a new MetaData instance with creation time now.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getCreateTime() Returns a time stamp that is automatically filled with the time the event instance was created by the language binding.
long	getDeliverTime() Returns the time at which an event was decoded and will be dispatched to the client as soon as possible (set directly before passing it to the client handler).
long	getReceiveTime() Returns the time at which an event is received by listener in its encoded form.
long	getSendTime() Returns the time at which the generated notification for an event was sent on the bus (after serialization).
java.lang.String	getUserInfo(java.lang.String key) Returns the user-defined string for the given key.
long	getUserTime(java.lang.String key) Returns the user timestamp stored under the provided key.
int	hashCode()
boolean	hasUserInfo(java.lang.String key) Checks whether a user info exists under the provided key.
boolean	hasUserTime(java.lang.String key) Checks whether a user-provided timestamp with the given key exists
void	setCreateTime(long time) Sets the time stamp that is automatically filled with the time the event instance was created by the language binding.
void	setDeliverTime(long time) Sets the time at which an event was decoded and will be dispatched to the client as soon as possible (set directly before passing it to the client handler).
void	setReceiveTime(long time) Sets the time at which an event is received by listener in its encoded form.
void	setSendTime(long time) Sets the time at which the generated notification for an event was sent on the bus (after serialization).
void	setUserInfo(java.lang.String key, java.lang.String value) Sets a user info with the specified key and value or replaces and already existing one
void	setUserTime(java.lang.String key, long time) Sets a user timestamp and replaces existing entries.
java.lang.String	toString()
java.util.Set<java.lang.String>	userInfoKeys() Returns all keys of user-defined infos.
java.util.Set<java.lang.String>	userTimeKeys() Returns the keys of all available user times.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaData

public MetaData()

Creates a new MetaData instance with creation time now.

Method Detail

getCreateTime

public long getCreateTime()

Returns a time stamp that is automatically filled with the time the event instance was created by the language binding. This should usually reflect the time at which the notified condition most likely occurred in the sender. If event instances are reused, it has to be reset manually by the client. This timestamp is initially set to the creating time stamp of this instance.

Returns:

timestamp in microseconds

setCreateTime

public void setCreateTime(long time)

Sets the time stamp that is automatically filled with the time the event instance was created by the language binding. This should usually reflect the time at which the notified condition most likely occurred in the sender. If event instances are reused, it has to be reset manually by the client.

Parameters:

time - timestamp in microseconds or 0 to use current system time

getSendTime

public long getSendTime()

Returns the time at which the generated notification for an event was sent on the bus (after serialization).

Returns:

timestamp in microseconds

setSendTime

public void setSendTime(long time)

Sets the time at which the generated notification for an event was sent on the bus (after serialization).

Parameters:

time - timestamp in microseconds or 0 to use current system time

getReceiveTime

public long getReceiveTime()

Returns the time at which an event is received by listener in its encoded form.

Returns:

timestamp in microseconds

setReceiveTime

public void setReceiveTime(long time)

Sets the time at which an event is received by listener in its encoded form.

Parameters:

time - timestamp in microseconds or 0 to use current system time

getDeliverTime

public long getDeliverTime()

Returns the time at which an event was decoded and will be dispatched to the client as soon as possible (set directly before passing it to the client handler).

Returns:

timestamp in microseconds

setDeliverTime

public void setDeliverTime(long time)

Sets the time at which an event was decoded and will be dispatched to the client as soon as possible (set directly before passing it to the client handler).

Parameters:

time - timestamp in microseconds or 0 to use current system time

userTimeKeys

public java.util.Set<java.lang.String> userTimeKeys()

Returns the keys of all available user times.

Returns:

set of all keys

hasUserTime

public boolean hasUserTime(java.lang.String key)

Checks whether a user-provided timestamp with the given key exists

Parameters:

key - the key to check

Returns:

true if a timestamp for the given key exists, else false

getUserTime

public long getUserTime(java.lang.String key)

Returns the user timestamp stored under the provided key.

Parameters:

key - key of the user-provided timestamp

Returns:

timetamp

Throws:

java.lang.IllegalArgumentException - no timestamp stored und the provided key

setUserTime

public void setUserTime(java.lang.String key,
               long time)

Sets a user timestamp and replaces existing entries.

Parameters:

key - the key for the timestamp

time - time in microseconds or 0 to use current system time

userInfoKeys

public java.util.Set<java.lang.String> userInfoKeys()

Returns all keys of user-defined infos.

Returns:

set of all defined keys

hasUserInfo

public boolean hasUserInfo(java.lang.String key)

Checks whether a user info exists under the provided key.

Parameters:

key - key to check

Returns:

true if an info for the key is defined, else false

getUserInfo

public java.lang.String getUserInfo(java.lang.String key)

Returns the user-defined string for the given key.

Parameters:

key - key to look up

Returns:

user info given for this key

Throws:

java.lang.IllegalArgumentException - no info set for the specified key

setUserInfo

public void setUserInfo(java.lang.String key,
               java.lang.String value)

Sets a user info with the specified key and value or replaces and already existing one

Parameters:

key - the key to set

value - the user value

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object