Package com.intellij.util.messages

Interface MessageBusConnection

All Superinterfaces:

Disposable

public interface MessageBusConnection
extends Disposable

Aggregates multiple topic subscriptions for particular message bus. I.e. every time a client wants to listen for messages it should grab appropriate connection (or create a new one) and subscribe to particular endpoint.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
void	deliverImmediately() Forces to process any queued but not delivered events.
void	disconnect() Disconnects current connections from the message bus and drops all queued but not dispatched messages (if any)
void	setDefaultHandler(MessageHandler handler) Allows to specify default handler to use during anonymous subscriptions.
<L> void	subscribe(Topic<L> topic) Subscribes to the target topic within the current connection using default handler.
<L> void	subscribe(Topic<L> topic, L handler) Subscribes given handler to the target endpoint within the current connection.

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Method Detail

subscribe

<L> void subscribe(Topic<L> topic,
                   L handler)
            throws java.lang.IllegalStateException

Subscribes given handler to the target endpoint within the current connection.

Type Parameters:

L - interface for working with the target topic

Parameters:

topic - target endpoint

handler - target handler to use for incoming messages

Throws:

java.lang.IllegalStateException - if there is already registered handler for the target endpoint within the current connection. Note that that previously registered handler is not replaced by the given one then

See Also:

MessageBus.syncPublisher(Topic), com.intellij.application.Topics#subscribe

subscribe

<L> void subscribe(Topic<L> topic)
            throws java.lang.IllegalStateException

Subscribes to the target topic within the current connection using default handler.

Type Parameters:

L - interface for working with the target topic

Parameters:

topic - target endpoint

Throws:

java.lang.IllegalStateException - if default handler hasn't been defined or has incompatible type with the topic's business interface or if target topic is already subscribed within the current connection

setDefaultHandler

void setDefaultHandler(MessageHandler handler)

Allows to specify default handler to use during anonymous subscriptions.

Parameters:

handler - handler to use

deliverImmediately

void deliverImmediately()

Forces to process any queued but not delivered events.

See Also:

MessageBus.syncPublisher(Topic)

disconnect

void disconnect()

Disconnects current connections from the message bus and drops all queued but not dispatched messages (if any)