rx.quasar

Class ChannelObservable

java.lang.Object

rx.quasar.ChannelObservable

public final class ChannelObservable
extends java.lang.Object

This class contains static methods that connect Observables and Channels.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> rx.Observable<T>	from(co.paralleluniverse.strands.channels.ReceivePort<T> channel) Converts an Iterable sequence into an Observable that emits each message received on the channel.
static <T> rx.Observable<T>	from(co.paralleluniverse.strands.channels.ReceivePort<T> channel, rx.Scheduler scheduler) Converts an Iterable sequence into an Observable that operates on the specified scheduler, emitting each message received on the channel.
static <T> T	get(rx.Observable<T> o) Takes an observable that generates at most one value, blocks until it completes and returns the result.
static <T> T	get(rx.Observable<T> o, long timeout, java.util.concurrent.TimeUnit unit) Takes an observable that generates at most one value, blocks until it completes or the timeout expires, and returns the result.
static <T> co.paralleluniverse.strands.channels.ReceivePort<T>	subscribe(int bufferSize, co.paralleluniverse.strands.channels.Channels.OverflowPolicy policy, rx.Observable<? extends T> o) Creates a ReceivePort subscribed to an Observable.
static <T> rx.Observer<T>	to(co.paralleluniverse.strands.channels.SendPort<T> channel) Converts a SendPort channel into an Observer.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static <T> rx.Observable<T> from(co.paralleluniverse.strands.channels.ReceivePort<T> channel)

Converts an Iterable sequence into an Observable that emits each message received on the channel.

Type Parameters:

T - the type of messages on the channel and the type of items to be emitted by the resulting Observable

Parameters:

channel - the source ReceivePort

Returns:

an Observable that emits each message received on the source ReceivePort

See Also:

RxJava Wiki: from()

from

public static <T> rx.Observable<T> from(co.paralleluniverse.strands.channels.ReceivePort<T> channel,
                        rx.Scheduler scheduler)

Converts an Iterable sequence into an Observable that operates on the specified scheduler, emitting each message received on the channel.

Type Parameters:

T - the type of messages on the channel and the type of items to be emitted by the resulting Observable

Parameters:

channel - the source ReceivePort

scheduler - the scheduler on which the Observable is to emit the messages received on the channel

Returns:

an Observable that emits each message received on the source ReceivePort, on the specified scheduler

See Also:

RxJava Wiki: from(), MSDN: Observable.ToObservable

to

public static <T> rx.Observer<T> to(co.paralleluniverse.strands.channels.SendPort<T> channel)

Converts a SendPort channel into an Observer.

Type Parameters:

T - the type of messages that can be sent to the channel and the type of items to be received by the Observer

Parameters:

channel - the target SendPort

Returns:

the observer

subscribe

public static <T> co.paralleluniverse.strands.channels.ReceivePort<T> subscribe(int bufferSize,
                                                                co.paralleluniverse.strands.channels.Channels.OverflowPolicy policy,
                                                                rx.Observable<? extends T> o)

Creates a ReceivePort subscribed to an Observable.

Type Parameters:

T - the type of messages emitted by the observable and received on the channel.

Parameters:

bufferSize - the channel's buffer size

policy - the channel's Channels.OverflowPolicy

o - the observable

Returns:

A new channel with the given buffer size and overflow policy that will receive all events emitted by the observable.

get

public static <T> T get(rx.Observable<T> o)
             throws java.util.concurrent.ExecutionException,
                    co.paralleluniverse.fibers.SuspendExecution,
                    java.lang.InterruptedException

Takes an observable that generates at most one value, blocks until it completes and returns the result. If the observable completes before a value has been emitted, this method returns null. It the observable fails, this function throws an ExecutionException that wraps the observable's exception.

Parameters:

o - the observable

Returns:

the observable's result, or null if the observable completes before a value is emitted.

Throws:

java.util.concurrent.ExecutionException - if the observable fails

co.paralleluniverse.fibers.SuspendExecution

java.lang.InterruptedException

get

public static <T> T get(rx.Observable<T> o,
        long timeout,
        java.util.concurrent.TimeUnit unit)
             throws java.util.concurrent.ExecutionException,
                    co.paralleluniverse.fibers.SuspendExecution,
                    java.lang.InterruptedException,
                    java.util.concurrent.TimeoutException

Takes an observable that generates at most one value, blocks until it completes or the timeout expires, and returns the result. If the observable completes before a value has been emitted, this method returns null. It the observable fails, this function throws an ExecutionException that wraps the observable's exception.

Parameters:

o - the observable

timeout - the maximum time this method will blcok

unit - the timeout's time unit

Returns:

the observable's result, or null if the observable completes before a value is emitted.

Throws:

java.util.concurrent.ExecutionException - if the observable fails

java.util.concurrent.TimeoutException - if the timeout expires before the observable completes

co.paralleluniverse.fibers.SuspendExecution

java.lang.InterruptedException