com.smartdevicelink.proxy.rpc.listeners

Class OnRPCResponseListener

java.lang.Object

com.smartdevicelink.proxy.rpc.listeners.OnRPCListener

com.smartdevicelink.proxy.rpc.listeners.OnRPCResponseListener

Direct Known Subclasses:

OnMultipleRequestListener

public abstract class OnRPCResponseListener
extends OnRPCListener

Field Summary

Fields inherited from class com.smartdevicelink.proxy.rpc.listeners.OnRPCListener

UPDATE_LISTENER_TYPE_ALL_RPCS, UPDATE_LISTENER_TYPE_BASE_RPC, UPDATE_LISTENER_TYPE_MULTIPLE_REQUESTS

Constructor Summary

Constructors

Constructor and Description
OnRPCResponseListener()

Method Summary

Modifier and Type	Method and Description
void	onReceived(RPCMessage message) This is the only method that must be extended.
abstract void	onResponse(int correlationId, RPCResponse response) This is the only method that must be extended.
void	onStart(int correlationId) This method will be called once the packet has been entered into the queue of messages to send

Methods inherited from class com.smartdevicelink.proxy.rpc.listeners.OnRPCListener

getListenerType, setListenerType

Methods inherited from class java.lang.Object

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

Constructor Detail

OnRPCResponseListener

public OnRPCResponseListener()

Method Detail

onReceived

public final void onReceived(RPCMessage message)

Description copied from class: OnRPCListener

This is the only method that must be extended.

Specified by:

onReceived in class OnRPCListener

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.

onStart

public void onStart(int correlationId)

This method will be called once the packet has been entered into the queue of messages to send

Parameters:

correlationId -

onResponse

public abstract void onResponse(int correlationId,
                                RPCResponse response)

This is the only method that must be extended. Other methods that are able to be extended are onStart and onError.

Parameters:

correlationId -

response - 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.