io.reactivex.remote

Class RemoteObservable<T>

java.lang.Object

io.reactivex.remote.RemoteObservable<T>

Type Parameters:

T - Supported types are String, Byte, Short, Integer, Long, Float, Double, Boolean, Parcelable, or any class annotated with @Parcel

All Implemented Interfaces:

android.os.Parcelable

public class RemoteObservable<T>
extends java.lang.Object
implements android.os.Parcelable

Observable across android remote services.

This is a Parcelable which can be passed through remote service aidl or Remoter interfaces and then get an Observable from this class at the client side.

At the client side either use getObservable() to get an Observable, or use getData(boolean) to directly get the last data and register for updates using setDataListener(RemoteDataListener)

RemoteObservable can be created using the factory class RemoteObservables

or manually from either an Observable using #RemoteObservable(Observable) or RemoteEventController using RemoteObservable(RemoteEventController)

See Also:

RemoteObservables

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<RemoteObservable>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
RemoteObservable(<any> sourceObservable) Initialize at the service side with an Observable
RemoteObservable(RemoteEventController<T> remoteController) Initialize at the service side with the RemoteEventController

Method Summary

Modifier and Type	Method and Description
void	close() Close this RemoteObservable No further events will be delivered
int	describeContents()
T	getData() Returns the last data received, blocking until one is available.
T	getData(boolean wait) Returns the last data received, optionally blocking till the data is received
<any>	getObservable() Returns an Observable which will receive the data send from the service side.
void	setDataListener(RemoteDataListener<T> dataListener) Sets a listener to get notified of data.
void	setDebug(boolean enable) Enable or disable debug prints.
void	setReconnecter(java.util.concurrent.Callable<RemoteObservable<T>> reconnecter) Sets a Callable to be used to reconnect if the connection with the remote service dies.
RemoteObservable<T>	setRemoteObservableListener(RemoteObservableListener remoteObservableListener) Set the listener to get notified when remote end closes connection.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<RemoteObservable> CREATOR

Constructor Detail

RemoteObservable

public RemoteObservable(RemoteEventController<T> remoteController)

Initialize at the service side with the RemoteEventController

Parameters:

remoteController - RemoteEventController used for generating the events

RemoteObservable

public RemoteObservable(<any> sourceObservable)

Initialize at the service side with an Observable

Parameters:

sourceObservable - Observable whose data needs to be delivered remotely

Method Detail

setRemoteObservableListener

public RemoteObservable<T> setRemoteObservableListener(RemoteObservableListener remoteObservableListener)

Set the listener to get notified when remote end closes connection. Use in the service side to get notified about client connections

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

getObservable

public <any> getObservable()

Returns an Observable which will receive the data send from the service side.

getData

public T getData()

Returns the last data received, blocking until one is available.

See Also:

getData(boolean)

getData

public T getData(boolean wait)

Returns the last data received, optionally blocking till the data is received

Parameters:

wait - If true, this call will block until a data is available

setDataListener

public void setDataListener(RemoteDataListener<T> dataListener)

Sets a listener to get notified of data. This is another way to get the data other than the getObservable()

Parameters:

dataListener - RemoteDataListener to get notified

close

public void close()

Close this RemoteObservable No further events will be delivered

setReconnecter

public void setReconnecter(java.util.concurrent.Callable<RemoteObservable<T>> reconnecter)

Sets a Callable to be used to reconnect if the connection with the remote service dies.

setDebug

public void setDebug(boolean enable)

Enable or disable debug prints. Disabled by default