Public Member Functions | |
void | addMessageListener (MessageListener< T > messageListener, int limit) |
void | addMessageListener (MessageListener< T > messageListener) |
void | addPublisher (PublisherIdentifier publisherIdentifier, InetSocketAddress address) |
void | addSubscriberListener (SubscriberListener< T > listener) |
boolean | getLatchMode () |
Collection< String > | getSupportedProtocols () |
void | shutdown (long timeout, TimeUnit unit) |
void | shutdown () |
void | signalOnMasterRegistrationFailure () |
void | signalOnMasterRegistrationSuccess () |
void | signalOnMasterUnregistrationFailure () |
void | signalOnMasterUnregistrationSuccess () |
void | signalOnNewPublisher (final PublisherIdentifier publisherIdentifier) |
SubscriberDeclaration | toDeclaration () |
SubscriberIdentifier | toIdentifier () |
String | toString () |
void | updatePublishers (Collection< PublisherIdentifier > publisherIdentifiers) |
Static Public Member Functions | |
static< S > DefaultSubscriber< S > | newDefault (NodeIdentifier nodeIdentifier, TopicDeclaration description, ScheduledExecutorService executorService, MessageDeserializer< S > deserializer) |
Private Member Functions | |
DefaultSubscriber (NodeIdentifier nodeIdentifier, TopicDeclaration topicDeclaration, MessageDeserializer< T > deserializer, ScheduledExecutorService executorService) | |
void | signalOnShutdown (long timeout, TimeUnit unit) |
Private Attributes | |
final ScheduledExecutorService | executorService |
final IncomingMessageQueue< T > | incomingMessageQueue |
final Set< PublisherIdentifier > | knownPublishers |
final Object | mutex |
final NodeIdentifier | nodeIdentifier |
final ListenerGroup < SubscriberListener< T > > | subscriberListeners |
final TcpClientManager | tcpClientManager |
Static Private Attributes | |
static final int | DEFAULT_SHUTDOWN_TIMEOUT = 5 |
static final TimeUnit | DEFAULT_SHUTDOWN_TIMEOUT_UNITS = TimeUnit.SECONDS |
static final Log | log = LogFactory.getLog(DefaultPublisher.class) |
Default implementation of a Subscriber.
Definition at line 48 of file DefaultSubscriber.java.
org.ros.internal.node.topic.DefaultSubscriber< T >.DefaultSubscriber | ( | NodeIdentifier | nodeIdentifier, |
TopicDeclaration | topicDeclaration, | ||
MessageDeserializer< T > | deserializer, | ||
ScheduledExecutorService | executorService | ||
) | [inline, private] |
Definition at line 78 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.addMessageListener | ( | MessageListener< T > | messageListener, |
int | limit | ||
) | [inline] |
Definition at line 133 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.addMessageListener | ( | MessageListener< T > | messageListener | ) | [inline] |
Definition at line 138 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.addPublisher | ( | PublisherIdentifier | publisherIdentifier, |
InetSocketAddress | address | ||
) | [inline] |
Definition at line 143 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.addSubscriberListener | ( | SubscriberListener< T > | listener | ) | [inline] |
Definition at line 187 of file DefaultSubscriber.java.
boolean org.ros.internal.node.topic.DefaultSubscriber< T >.getLatchMode | ( | ) | [inline] |
Definition at line 128 of file DefaultSubscriber.java.
Collection<String> org.ros.internal.node.topic.DefaultSubscriber< T >.getSupportedProtocols | ( | ) | [inline] |
Definition at line 123 of file DefaultSubscriber.java.
static <S> DefaultSubscriber<S> org.ros.internal.node.topic.DefaultSubscriber< T >.newDefault | ( | NodeIdentifier | nodeIdentifier, |
TopicDeclaration | description, | ||
ScheduledExecutorService | executorService, | ||
MessageDeserializer< S > | deserializer | ||
) | [inline, static] |
Definition at line 72 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.shutdown | ( | long | timeout, |
TimeUnit | unit | ||
) | [inline] |
Definition at line 174 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.shutdown | ( | ) | [inline] |
Definition at line 182 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.signalOnMasterRegistrationFailure | ( | ) | [inline, virtual] |
Signal all SubscriberListeners that the Subscriber has failed to register with the master.
Each listener is called in a separate thread.
Implements org.ros.internal.node.topic.DefaultTopicParticipant.
Definition at line 216 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.signalOnMasterRegistrationSuccess | ( | ) | [inline, virtual] |
Signal all SubscriberListeners that the Subscriber has successfully registered with the master.
Each listener is called in a separate thread.
Implements org.ros.internal.node.topic.DefaultTopicParticipant.
Definition at line 198 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.signalOnMasterUnregistrationFailure | ( | ) | [inline, virtual] |
Signal all SubscriberListeners that the Subscriber has failed to unregister with the master.
Each listener is called in a separate thread.
Implements org.ros.internal.node.topic.DefaultTopicParticipant.
Definition at line 250 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.signalOnMasterUnregistrationSuccess | ( | ) | [inline, virtual] |
Signal all SubscriberListeners that the Subscriber has successfully unregistered with the master.
Each listener is called in a separate thread.
Implements org.ros.internal.node.topic.DefaultTopicParticipant.
Definition at line 233 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.signalOnNewPublisher | ( | final PublisherIdentifier | publisherIdentifier | ) | [inline] |
Signal all SubscriberListeners that a new Publisher has connected.
Each listener is called in a separate thread.
Definition at line 266 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.signalOnShutdown | ( | long | timeout, |
TimeUnit | unit | ||
) | [inline, private] |
Signal all SubscriberListeners that the Subscriber has shut down.
Each listener is called in a separate thread.
Definition at line 282 of file DefaultSubscriber.java.
SubscriberDeclaration org.ros.internal.node.topic.DefaultSubscriber< T >.toDeclaration | ( | ) | [inline] |
Definition at line 119 of file DefaultSubscriber.java.
SubscriberIdentifier org.ros.internal.node.topic.DefaultSubscriber< T >.toIdentifier | ( | ) | [inline] |
Definition at line 115 of file DefaultSubscriber.java.
String org.ros.internal.node.topic.DefaultSubscriber< T >.toString | ( | ) | [inline] |
Definition at line 298 of file DefaultSubscriber.java.
void org.ros.internal.node.topic.DefaultSubscriber< T >.updatePublishers | ( | Collection< PublisherIdentifier > | publisherIdentifiers | ) | [inline] |
Updates the list of Publishers for the topic that this Subscriber is interested in.
publisherIdentifiers | Collection of PublisherIdentifiers for the subscribed topic |
Definition at line 166 of file DefaultSubscriber.java.
final int org.ros.internal.node.topic.DefaultSubscriber< T >.DEFAULT_SHUTDOWN_TIMEOUT = 5 [static, private] |
The maximum delay before shutdown will begin even if all SubscriberListeners have not yet returned from their SubscriberListener#onShutdown(Subscriber) callback.
Definition at line 57 of file DefaultSubscriber.java.
final TimeUnit org.ros.internal.node.topic.DefaultSubscriber< T >.DEFAULT_SHUTDOWN_TIMEOUT_UNITS = TimeUnit.SECONDS [static, private] |
Definition at line 58 of file DefaultSubscriber.java.
final ScheduledExecutorService org.ros.internal.node.topic.DefaultSubscriber< T >.executorService [private] |
Definition at line 61 of file DefaultSubscriber.java.
final IncomingMessageQueue<T> org.ros.internal.node.topic.DefaultSubscriber< T >.incomingMessageQueue [private] |
Definition at line 62 of file DefaultSubscriber.java.
final Set<PublisherIdentifier> org.ros.internal.node.topic.DefaultSubscriber< T >.knownPublishers [private] |
Definition at line 63 of file DefaultSubscriber.java.
final Log org.ros.internal.node.topic.DefaultSubscriber< T >.log = LogFactory.getLog(DefaultPublisher.class) [static, private] |
Definition at line 50 of file DefaultSubscriber.java.
final Object org.ros.internal.node.topic.DefaultSubscriber< T >.mutex [private] |
Definition at line 65 of file DefaultSubscriber.java.
final NodeIdentifier org.ros.internal.node.topic.DefaultSubscriber< T >.nodeIdentifier [private] |
Definition at line 60 of file DefaultSubscriber.java.
final ListenerGroup<SubscriberListener<T> > org.ros.internal.node.topic.DefaultSubscriber< T >.subscriberListeners [private] |
Manages the SubscriberListeners for this Subscriber.
Definition at line 70 of file DefaultSubscriber.java.
final TcpClientManager org.ros.internal.node.topic.DefaultSubscriber< T >.tcpClientManager [private] |
Definition at line 64 of file DefaultSubscriber.java.