MetaData

public class MetaData

Framework-supplied meta data attached to each event that give information e.g. about timing issues. In case you are setting timestamps manually, ensure to create these timestamps using ExactTime to get the highest possible resolution.

Author

jwienke

Constructors

MetaData

public MetaData()

Creates a new MetaData instance with creation time now.

Methods

equals

public boolean equals(Object obj)

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

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

getReceiveTime

public long getReceiveTime()

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

Returns

timestamp in microseconds

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

getUserInfo

public String getUserInfo(String key)

Returns the user-defined string for the given key.

Parameters

key – key to look up

Throws

IllegalArgumentException – no info set for the specified key

Returns

user info given for this key

getUserTime

public long getUserTime(String key)

Returns the user timestamp stored under the provided key.

Parameters

key – key of the user-provided timestamp

Throws

IllegalArgumentException – no timestamp stored und the provided key

Returns

timetamp

hasUserInfo

public boolean hasUserInfo(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

hasUserTime

public boolean hasUserTime(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

hashCode

public int hashCode()

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

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

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

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

setUserInfo

public void setUserInfo(String key, 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

setUserTime

public void setUserTime(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

toString

public String toString()

userInfoKeys

public Set<String> userInfoKeys()

Returns all keys of user-defined infos.

Returns

set of all defined keys

userTimeKeys

public Set<String> userTimeKeys()

Returns the keys of all available user times.

Returns

set of all keys