org.mbs.services.cup.data

Class SVEventSubscription

java.lang.Object

org.mbs.services.cup.data.SVEventSubscription

Direct Known Subclasses:

CUEventSubscription, HEventSubscription

public class SVEventSubscription
extends java.lang.Object

A structure containing the properties needed for subscribing for state variable events notification.

See Also:

ControlUnitProxy#subscribe

Field Summary

Fields

Modifier and Type	Field and Description
protected long	eventTimeout Max timeout (in milliseconds) after which an event should be delivered.
protected java.lang.String	expiredEventsFilter Expired events filter.
protected java.util.Dictionary	listenerRegProps Registration properties of the listener service.

Constructor Summary

Constructors

Constructor and Description
SVEventSubscription() Empty constructor.
SVEventSubscription(java.util.Dictionary listenerRegProps, java.lang.String expiredEventsFilter, long eventTimeout) Creates a SVEventSubscription object with given event filter and attirubtes specifying the event delivering behavior.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExpiredEventsFilter() Returns the filter for expired events in this subscription.
java.util.Dictionary	getListenerRegProps() Returns registration properties of the listener service.
long	getTimeout() Returns the event timeout for this subscription.
void	read(java.io.DataInputStream in) Method used for serialization.
void	write(java.io.DataOutputStream out) Method used for serialization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listenerRegProps

protected java.util.Dictionary listenerRegProps

Registration properties of the listener service.

expiredEventsFilter

protected java.lang.String expiredEventsFilter

Expired events filter.

eventTimeout

protected long eventTimeout

Max timeout (in milliseconds) after which an event should be delivered.

Constructor Detail

SVEventSubscription

public SVEventSubscription()

Empty constructor.

SVEventSubscription

public SVEventSubscription(java.util.Dictionary listenerRegProps,
                           java.lang.String expiredEventsFilter,
                           long eventTimeout)

Creates a SVEventSubscription object with given event filter and attirubtes specifying the event delivering behavior.

Parameters:

listenerRegProps - registration properties of the listener service. The StateVariableListener on the target framework to serve this subscription shall be registered with the registration properties applied with this argument.

expiredEventsFilter - - filter in ldap form, specifying the sub set of state variable events for which all events (even the expired ones) should be delivered. An event is considered as expired if in the current event chunk of non-sent events, a state variable has been changed more than once. In this case, only the last event for this state variable is not considered as expired. By default the expired events are not sent, because they have no sense, since the subsequent event is overriding the state variable value. Expired event notifications are suitable for state machine applications that need the complete event sequence to realize their logic.

eventTimeout - max timeout (in milliseconds) after which a state variable event should be delivered. Zero or negative number means that every event should be delivered without any delay. If it is a negative number – then the event notification shall be sent immediately within synchronous messages.
Specifying a delay is useful for increasing the performance of notifications sending – if two or more events are raised within a short time - they shall be delivered within a single packet.

Method Detail

getListenerRegProps

public java.util.Dictionary getListenerRegProps()

Returns registration properties of the listener service.

Returns:

event filter of this subscription.

getTimeout

public long getTimeout()

Returns the event timeout for this subscription.

Returns:

the event timeout for this subscription.

getExpiredEventsFilter

public java.lang.String getExpiredEventsFilter()

Returns the filter for expired events in this subscription.

Returns:

filter for expired events in this subscription.

read

public void read(java.io.DataInputStream in)
          throws java.io.IOException

Method used for serialization.

Parameters:

in - input stream.

Throws:

java.io.IOException - if error while reading data occurs.

write

public void write(java.io.DataOutputStream out)
           throws java.io.IOException

Method used for serialization.

Parameters:

out - output stream.

Throws:

java.io.IOException - error while writing data occurs.