com.yahoo.bard.webservice.async.broadcastchannels

Class SimpleBroadcastChannel<T>

java.lang.Object

com.yahoo.bard.webservice.async.broadcastchannels.SimpleBroadcastChannel<T>

Type Parameters:

T - The type of message that the SimpleBroadcastChannel publishes

All Implemented Interfaces:

BroadcastChannel<T>, Closeable, AutoCloseable

@Singleton
public class SimpleBroadcastChannel<T>
extends Object
implements BroadcastChannel<T>

A simple implementation of BroadcastChannel backed by a Subject intended for use in systems with a single Bard instance.

Field Summary

Fields inherited from interface com.yahoo.bard.webservice.async.broadcastchannels.BroadcastChannel

PUBLISH_ON_CLOSED_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor and Description
SimpleBroadcastChannel(rx.subjects.Subject<T,T> notifications) Construct a SimpleBroadcastChannel using a Hot Observable.

Method Summary

Modifier and Type	Method and Description
void	close()
rx.Observable<T>	getNotifications() This method returns a Hot Observable (Observable which emits events whether someone is listening or not) that emits all the notifications passed to it by Bard instances in the cluster.
void	publish(T message) Publish is used to publish a message from a Bard box.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBroadcastChannel

public SimpleBroadcastChannel(rx.subjects.Subject<T,T> notifications)

Construct a SimpleBroadcastChannel using a Hot Observable.

Parameters:

notifications - A hot subject that will be used to send messages to and receive messages from other SimpleBroadcastChannels

Method Detail

publish

public void publish(T message)
             throws UnsupportedOperationException

Description copied from interface: BroadcastChannel

Publish is used to publish a message from a Bard box.

Specified by:

publish in interface BroadcastChannel<T>

Parameters:

message - The message to be published

Throws:

UnsupportedOperationException - if someone attempts to publish to the channel after it has been closed

getNotifications

public rx.Observable<T> getNotifications()

Description copied from interface: BroadcastChannel

This method returns a Hot Observable (Observable which emits events whether someone is listening or not) that emits all the notifications passed to it by Bard instances in the cluster.

Specified by:

getNotifications in interface BroadcastChannel<T>

Returns:

An unbounded stream of notifications from Bard instances

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable