org.fabric3.spi.container.channel

Interface Channel

public interface Channel

An event channel. Responsible for transmitting events from producers to consumers. A logical channel is divided into two physical channels on a runtime: one for receiving events from producers and transmitting them to a binding; and one for receiving events from a binding and transmitting them to consumers. If the channel is not bound, it is collocated and only one physical channel will exist.

Method Summary

Modifier and Type	Method and Description
void	addHandler(EventStreamHandler handler) Adds a handler for transmitting events to the channel.
void	attach(ChannelConnection connection) Attach a connection to the channel so that it can flow events.
void	attach(EventStreamHandler handler) Attach a single handler to the channel so that it can flow events.
ChannelSide	getChannelSide() Returns if the Channel receives producer events or sends events to consumers.
java.net.URI	getContributionUri() Returns the URI of the contribution this channel was deployed with.
java.lang.Object	getDirectConnection(java.lang.String topic) Returns a direct connection to the channel, typically the dispatcher such as a ring buffer.
java.net.URI	getUri() Returns the channel URI.
void	removeHandler(EventStreamHandler handler) Removes a handler.
void	start() Initializes the channel to receive events.
void	stop() Stops the channel and prepares it for un-deployment
void	subscribe(java.net.URI uri, ChannelConnection connection) Subscribe to receive events from the channel.
ChannelConnection	unsubscribe(java.net.URI uri, java.lang.String topic) Unsubscribe from receiving events from the channel

Method Detail

getUri

java.net.URI getUri()

Returns the channel URI.

Returns:

the channel URI

getContributionUri

java.net.URI getContributionUri()

Returns the URI of the contribution this channel was deployed with.

Returns:

the contribution URI

start

void start()

Initializes the channel to receive events.

stop

void stop()

Stops the channel and prepares it for un-deployment

addHandler

void addHandler(EventStreamHandler handler)

Adds a handler for transmitting events to the channel.

Parameters:

handler - the handler

removeHandler

void removeHandler(EventStreamHandler handler)

Removes a handler.

Parameters:

handler - the handler

attach

void attach(EventStreamHandler handler)

Attach a single handler to the channel so that it can flow events.

Parameters:

handler - the handler to attach

attach

void attach(ChannelConnection connection)

Attach a connection to the channel so that it can flow events.

Parameters:

connection - the connection to attach

subscribe

void subscribe(java.net.URI uri,
               ChannelConnection connection)

Subscribe to receive events from the channel.

Parameters:

uri - the URI identifying the subscription

connection - the connection to receive events on

unsubscribe

ChannelConnection unsubscribe(java.net.URI uri,
                              java.lang.String topic)

Unsubscribe from receiving events from the channel

Parameters:

uri - the subscription URI

topic - the topic; may be null

Returns:

the unsubscribed connection

getChannelSide

ChannelSide getChannelSide()

Returns if the Channel receives producer events or sends events to consumers.

Returns:

if the Channel receives producer events or sends events to consumers

getDirectConnection

java.lang.Object getDirectConnection(java.lang.String topic)

Returns a direct connection to the channel, typically the dispatcher such as a ring buffer.

Parameters:

topic - the topic; may be null

Returns:

a direct connection ot the channel