com.smartdevicelink.proxy.rpc.listeners

Class OnRPCListener

java.lang.Object

com.smartdevicelink.proxy.rpc.listeners.OnRPCListener

Direct Known Subclasses:

OnRPCRequestListener, OnRPCResponseListener

public abstract class OnRPCListener
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	UPDATE_LISTENER_TYPE_ALL_RPCS Generic listener for all RPCs including Requests, response, and notification
static int	UPDATE_LISTENER_TYPE_BASE_RPC Generic listener type that will work for most RPCs
static int	UPDATE_LISTENER_TYPE_MULTIPLE_REQUESTS Listener type specific to sendRequests and sendSequentialRequests

Constructor Summary

Constructors

Constructor and Description
OnRPCListener() This is the base listener for all RPCs.

Method Summary

Modifier and Type	Method and Description
int	getListenerType() This is used to see what type of listener this instance is.
abstract void	onReceived(RPCMessage message) This is the only method that must be extended.
protected void	setListenerType(int type)

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_LISTENER_TYPE_ALL_RPCS

public static final int UPDATE_LISTENER_TYPE_ALL_RPCS

Generic listener for all RPCs including Requests, response, and notification

See Also:

Constant Field Values

UPDATE_LISTENER_TYPE_BASE_RPC

public static final int UPDATE_LISTENER_TYPE_BASE_RPC

Generic listener type that will work for most RPCs

See Also:

Constant Field Values

UPDATE_LISTENER_TYPE_MULTIPLE_REQUESTS

public static final int UPDATE_LISTENER_TYPE_MULTIPLE_REQUESTS

Listener type specific to sendRequests and sendSequentialRequests

See Also:

Constant Field Values

Constructor Detail

OnRPCListener

public OnRPCListener()

This is the base listener for all RPCs.

Method Detail

setListenerType

protected final void setListenerType(int type)

getListenerType

public int getListenerType()

This is used to see what type of listener this instance is. It is needed because some RPCs require additional callbacks. Types are constants located in this class

Returns:

the type of listener this is

onReceived

public abstract void onReceived(RPCMessage message)

This is the only method that must be extended.

Parameters:

message - This will be the response message received from the core side. It should be cast into a corresponding RPC Response type. ie, if setting this for a PutFile request, the message parameter should be cast to a PutFileResponse class.