com.smartdevicelink.managers

Interface ISdl

public interface ISdl

Method Summary

Modifier and Type	Method and Description
void	addOnRPCListener(FunctionID responseId, OnRPCListener listener) Add an OnRPCResponseListener for specified response
void	addOnRPCNotificationListener(FunctionID notificationId, OnRPCNotificationListener listener) Add an OnRPCNotificationListener for specified notification
void	addOnRPCRequestListener(FunctionID functionID, OnRPCRequestListener listener) Add an OnRPCRequestListener for specified request
void	addServiceListener(SessionType serviceType, ISdlServiceListener sdlServiceListener) Add a service listener for a specific service type
long	getMtu(SessionType serviceType) Get the max payload size for a packet to be sent to the module
PermissionManager	getPermissionManager()
Version	getProtocolVersion() Get the protocol version of this session
RegisterAppInterfaceResponse	getRegisterAppInterfaceResponse() Get RegisterAppInterfaceResponse
SdlMsgVersion	getSdlMsgVersion() Get the RPC specification version currently being used for the SDL messages
SystemCapabilityManager	getSystemCapabilityManager()
com.livio.taskmaster.Taskmaster	getTaskmaster()
boolean	isConnected() Method to check if the session is connected
boolean	isTransportForServiceAvailable(SessionType serviceType) Check to see if a transport is available to start/use the supplied service.
boolean	removeOnRPCListener(FunctionID responseId, OnRPCListener listener) Removes an OnRPCResponseListener for specified response
boolean	removeOnRPCNotificationListener(FunctionID notificationId, OnRPCNotificationListener listener) Removes an OnRPCNotificationListener for specified notification
boolean	removeOnRPCRequestListener(FunctionID functionID, OnRPCRequestListener listener) Removes an OnRPCRequestListener for specified request
void	removeServiceListener(SessionType serviceType, ISdlServiceListener sdlServiceListener) Remote a service listener for a specific service type
void	sendRPC(RPCMessage message) Pass an RPC message through the proxy to be sent to the connected module
void	sendRPCs(List<? extends RPCMessage> rpcs, OnMultipleRequestListener listener) Pass a list of RPC messages through the proxy to be sent to core
void	sendSequentialRPCs(List<? extends RPCMessage> rpcs, OnMultipleRequestListener listener) Takes a list of RPCMessages and sends it to SDL in a synchronous fashion.
void	start() Starts the connection with the module
void	startAudioService(boolean encrypted) Starts the Audio streaming service
void	startRPCEncryption() Start encrypted RPC service
void	startVideoService(VideoStreamingParameters parameters, boolean encrypted, boolean withPendingRestart) Starts the video streaming service
void	stop() Ends connection with the module

Method Detail

start

void start()

Starts the connection with the module

stop

void stop()

Ends connection with the module

isConnected

boolean isConnected()

Method to check if the session is connected

Returns:

if there is a connected session

addServiceListener

void addServiceListener(SessionType serviceType,
                        ISdlServiceListener sdlServiceListener)

Add a service listener for a specific service type

Parameters:

serviceType - service type that the listener will be attached to

sdlServiceListener - listener for events that happen to the service

removeServiceListener

void removeServiceListener(SessionType serviceType,
                           ISdlServiceListener sdlServiceListener)

Remote a service listener for a specific service type

Parameters:

serviceType - service type that the listener was attached to

sdlServiceListener - service listener that was previously added for the service type

startVideoService

void startVideoService(VideoStreamingParameters parameters,
                       boolean encrypted,
                       boolean withPendingRestart)

Starts the video streaming service

Parameters:

parameters - desired video streaming params for this service to be started with

encrypted - flag to start this service with encryption or not

withPendingRestart - flag to start this service right after OnSystemCapabilityUpdated

startAudioService

void startAudioService(boolean encrypted)

Starts the Audio streaming service

Parameters:

encrypted - flag to start this service with encryption or not

sendRPC

void sendRPC(RPCMessage message)

Pass an RPC message through the proxy to be sent to the connected module

Parameters:

message - RPCMessage that should be sent to the module

sendRPCs

void sendRPCs(List<? extends RPCMessage> rpcs,
              OnMultipleRequestListener listener)

Pass a list of RPC messages through the proxy to be sent to core

Parameters:

rpcs - List of RPC messages

listener - OnMultipleRequestListener that is called between requests and after all are processed

sendSequentialRPCs

void sendSequentialRPCs(List<? extends RPCMessage> rpcs,
                        OnMultipleRequestListener listener)

Takes a list of RPCMessages and sends it to SDL in a synchronous fashion. Responses are captured through callback on OnMultipleRequestListener. For sending requests asynchronously, use sendRequests
NOTE: This will override any listeners on individual RPCs
ADDITIONAL NOTE: This only takes the type of RPCRequest for now, notifications and responses will be thrown out

Parameters:

rpcs - is the list of RPCMessages being sent

listener - listener for updates and completions

addOnRPCNotificationListener

void addOnRPCNotificationListener(FunctionID notificationId,
                                  OnRPCNotificationListener listener)

Add an OnRPCNotificationListener for specified notification

Parameters:

notificationId - FunctionID of the notification that is to be listened for

listener - listener that should be added for the notification ID

removeOnRPCNotificationListener

boolean removeOnRPCNotificationListener(FunctionID notificationId,
                                        OnRPCNotificationListener listener)

Removes an OnRPCNotificationListener for specified notification

Parameters:

notificationId - FunctionID of the notification that was to be listened for

listener - listener that was previously added for the notification ID

addOnRPCRequestListener

void addOnRPCRequestListener(FunctionID functionID,
                             OnRPCRequestListener listener)

Add an OnRPCRequestListener for specified request

Parameters:

functionID - FunctionID of the request that is to be listened for

listener - listener that should be added for the request ID

removeOnRPCRequestListener

boolean removeOnRPCRequestListener(FunctionID functionID,
                                   OnRPCRequestListener listener)

Removes an OnRPCRequestListener for specified request

Parameters:

functionID - FunctionID of the request that was to be listened for

listener - listener that was previously added for the request ID

addOnRPCListener

void addOnRPCListener(FunctionID responseId,
                      OnRPCListener listener)

Add an OnRPCResponseListener for specified response

Parameters:

responseId - FunctionID of the response that is to be listened for

listener - listener that should be added for the response ID

removeOnRPCListener

boolean removeOnRPCListener(FunctionID responseId,
                            OnRPCListener listener)

Removes an OnRPCResponseListener for specified response

Parameters:

responseId - FunctionID of the response that was to be listened for

listener - listener that was previously added for the response ID

getRegisterAppInterfaceResponse

RegisterAppInterfaceResponse getRegisterAppInterfaceResponse()

Get RegisterAppInterfaceResponse

Returns:

the RegisterAppInterfaceResponse if available, null if not

isTransportForServiceAvailable

boolean isTransportForServiceAvailable(SessionType serviceType)

Check to see if a transport is available to start/use the supplied service.

Parameters:

serviceType - the session that should be checked for transport availability

Returns:

true if there is either a supported transport currently connected or a transport is available to connect with for the supplied service type.
false if there is no transport connected to support the service type in question and no possibility in the foreseeable future.

getSdlMsgVersion

@NonNull
SdlMsgVersion getSdlMsgVersion()

Get the RPC specification version currently being used for the SDL messages

Returns:

SdlMsgVersion the current RPC specification version

getProtocolVersion

@NonNull
Version getProtocolVersion()

Get the protocol version of this session

Returns:

byte value representing WiPro version

getMtu

long getMtu(SessionType serviceType)

Get the max payload size for a packet to be sent to the module

Returns:

the max transfer unit

startRPCEncryption

void startRPCEncryption()

Start encrypted RPC service

getTaskmaster

com.livio.taskmaster.Taskmaster getTaskmaster()

getSystemCapabilityManager

SystemCapabilityManager getSystemCapabilityManager()

getPermissionManager

PermissionManager getPermissionManager()