rsb

Class Participant

java.lang.Object

rsb.Participant

All Implemented Interfaces:

RSBObject

Direct Known Subclasses:

Informer, Listener, Server

public abstract class Participant
extends java.lang.Object
implements RSBObject

Base class for all bus participants with an associated scope. Mainly holds references to the router and configuration-level objects.

Author:

jwienke, swrede

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Participant(Scope scope, TransportFactory transportFactory, PortConfiguration portConfig) Creates a new participant on the specified scope.
protected	Participant(java.lang.String scope, TransportFactory transportFactory, PortConfiguration portConfig) Creates a new participant on the specified scope.

Method Summary

Methods

Modifier and Type	Method and Description
ParticipantId	getId() Returns the unique ID of this participant.
protected Router	getRouter() Returns the router used for this participant.
Scope	getScope() Returns the scope of this participant.
protected TransportFactory	getTransportFactory() Returns the TransportFactory used for this participant.

Methods inherited from class java.lang.Object

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

Methods inherited from interface rsb.RSBObject

activate, deactivate, isActive

Constructor Detail

Participant

protected Participant(Scope scope,
           TransportFactory transportFactory,
           PortConfiguration portConfig)

Creates a new participant on the specified scope.

Parameters:

scope - scope of the participant

transportFactory - the factory used for transports for this Participant

portConfig - type of ports to create for this participant

Participant

protected Participant(java.lang.String scope,
           TransportFactory transportFactory,
           PortConfiguration portConfig)

Creates a new participant on the specified scope.

Parameters:

scope - scope of the participant

transportFactory - the factory used for transports for this Participant

portConfig - type of ports to create for this participant

Method Detail

getId

public ParticipantId getId()

Returns the unique ID of this participant.

Returns:

the unique id of the participant

getScope

public Scope getScope()

Returns the scope of this participant.

Returns:

scope of the participant, not null

getTransportFactory

protected TransportFactory getTransportFactory()

Returns the TransportFactory used for this participant.

Returns:

instance not null

getRouter

protected Router getRouter()

Returns the router used for this participant.

Returns:

router used for this participant, not null