rsb

Class Informer<T>

java.lang.Object

rsb.Participant

rsb.Informer<T>

All Implemented Interfaces:

RSBObject

public class Informer<T>
extends Participant

This class offers a method to publish events to a channel, reaching all participating Listeners. This n:m-communication is one of the basic communication patterns offered by RSB.

Author:

swrede, rgaertne, jschaefe, jwienke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Informer.InformerStateActive
protected class	Informer.InformerStateInactive

Field Summary

Fields

Modifier and Type	Field and Description
protected ConverterSelectionStrategy<?>	converter converter repository for type mappings
protected SequenceNumber	sequenceNumber atomic uint32 counter object for event sequence numbers
protected InformerState<T>	state state variable for publisher instance
protected java.lang.Class<?>	type default data type for this publisher

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all network resources that belong to a specific object.
void	deactivate() Deactivate all network resources that are owned by a specific object in order to reactivate it.
java.lang.Class<?>	getTypeInfo() Returns the class describing the type of data sent by this informer.
boolean	isActive() Tells wether this class is currently active or not.
Event	send(Event event) Send an Event to all subscribed participants.
Event	send(T data) Send data (of type ) to all subscribed participants.
void	setTypeInfo(java.lang.Class<?> typeInfo) Set the class object describing the type of data sent by this informer.

Methods inherited from class rsb.Participant

getId, getRouter, getScope, getTransportFactory

Methods inherited from class java.lang.Object

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

Field Detail

state

protected InformerState<T> state

state variable for publisher instance

sequenceNumber

protected SequenceNumber sequenceNumber

atomic uint32 counter object for event sequence numbers

converter

protected ConverterSelectionStrategy<?> converter

converter repository for type mappings

type

protected java.lang.Class<?> type

default data type for this publisher

Method Detail

activate

public void activate()
              throws InitializeException

Description copied from interface: RSBObject

Activates all network resources that belong to a specific object.

Throws:

InitializeException

deactivate

public void deactivate()

Description copied from interface: RSBObject

Deactivate all network resources that are owned by a specific object in order to reactivate it.

send

public Event send(Event event)
           throws RSBException

Send an Event to all subscribed participants.

Parameters:

event - the event to send

Returns:

modified event with set timing information

Throws:

RSBException - error sending event

java.lang.IllegalArgumentException - if the event is not complete or does not match the type or scope settings of the informer

send

public Event send(T data)
           throws RSBException

Send data (of type ) to all subscribed participants.

Parameters:

data - data to send with default setting from the informer

Returns:

generated event

Throws:

RSBException - error sending event

getTypeInfo

public java.lang.Class<?> getTypeInfo()

Returns the class describing the type of data sent by this informer.

Returns:

string declarator

setTypeInfo

public void setTypeInfo(java.lang.Class<?> typeInfo)

Set the class object describing the type of data sent by this informer.

isActive

public boolean isActive()

Description copied from interface: RSBObject

Tells wether this class is currently active or not.

Returns:

true if active