io.reactivex.remote

Class RemoteEventController<T>

java.lang.Object

io.reactivex.remote.RemoteEventController<T>

Type Parameters:

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

public class RemoteEventController<T>
extends java.lang.Object

Use this class to send the data at the server side that needs to be delivered to the rx.Observable at the client side.

To send a event, use sendEvent(Object)

Use sendCompleted() to inform the client rx.Observable that the data stream is complete

Constructor Summary

Constructors

Constructor and Description
RemoteEventController() Create a default instance of RemoteEventController Use sendEvent(Object), sendCompleted() to send the data
RemoteEventController(<any> observable) Creates an instance of RemoteEventController with the given Observable

Method Summary

Modifier and Type	Method and Description
RemoteEventManager	getRemoteEventManager()
void	onClosed() Override this to know when the client closed the remote observable.
void	onSubscribed() Override this to know when first client subscribed to the observable
void	onUnSubscribed() Override this to know when ALL clients have unsubscribed.
void	sendCompleted() Generate an onCompleted event at the client observable.
void	sendError(java.lang.Exception exception) Generate an onError event at the client observable.
void	sendEvent(T data) Send the given data to the client observable
void	setDebug(boolean enable) Enable or disable debug prints.
void	setIgnoreIfDuplicateOfLast(boolean ignoreIfDuplicateOfLast) If set, the sendEvent(Object) wont be delivered if it is same as last event.
void	setRemoteObservableListener(RemoteObservableListener remoteObservableListener)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteEventController

public RemoteEventController()

Create a default instance of RemoteEventController Use sendEvent(Object), sendCompleted() to send the data

RemoteEventController

public RemoteEventController(<any> observable)

Creates an instance of RemoteEventController with the given Observable

Parameters:

observable - The Observable to listen to

Method Detail

getRemoteEventManager

public RemoteEventManager getRemoteEventManager()

setRemoteObservableListener

public void setRemoteObservableListener(RemoteObservableListener remoteObservableListener)

sendEvent

public final void sendEvent(T data)

Send the given data to the client observable

Parameters:

data - The data that needs to be send

sendCompleted

public final void sendCompleted()

Generate an onCompleted event at the client observable.

sendError

public final void sendError(java.lang.Exception exception)

Generate an onError event at the client observable.

onSubscribed

public void onSubscribed()

Override this to know when first client subscribed to the observable

onUnSubscribed

public void onUnSubscribed()

Override this to know when ALL clients have unsubscribed.

onClosed

public void onClosed()

Override this to know when the client closed the remote observable. Perform any cleanup here

setDebug

public void setDebug(boolean enable)

Enable or disable debug prints. Disabled by default

setIgnoreIfDuplicateOfLast

public void setIgnoreIfDuplicateOfLast(boolean ignoreIfDuplicateOfLast)

If set, the sendEvent(Object) wont be delivered if it is same as last event. Default false