Interface ISdl
- Package
- com.smartdevicelink.managers
Quick Jump
- Methods
-
- start()
- stop()
- isConnected()
- addServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)
- removeServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)
- startVideoService(VideoStreamingParameters parameters,boolean encrypted,boolean withPendingRestart)
- startAudioService(boolean encrypted)
- sendRPC(RPCMessage message)
- sendRPCs(java.util.List<? extends com.smartdevicelink.proxy.RPCMessage> rpcs,OnMultipleRequestListener listener)
- sendSequentialRPCs(java.util.List<? extends com.smartdevicelink.proxy.RPCMessage> rpcs,OnMultipleRequestListener listener)
- addOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)
- removeOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)
- addOnRPCRequestListener(FunctionID functionID,OnRPCRequestListener listener)
- removeOnRPCRequestListener(FunctionID functionID,OnRPCRequestListener listener)
- addOnRPCListener(FunctionID responseId,OnRPCListener listener)
- removeOnRPCListener(FunctionID responseId,OnRPCListener listener)
- getRegisterAppInterfaceResponse()
- isTransportForServiceAvailable(SessionType serviceType)
- getSdlMsgVersion()
- getProtocolVersion()
- getMtu(SessionType serviceType)
- startRPCEncryption()
- getTaskmaster()
- getSystemCapabilityManager()
- getPermissionManager()
Methods
start()
Starts the connection with the module
stop()
Ends connection with the module
isConnected()
Method to check if the session is connected
public boolean isConnected()
addServiceListener(
SessionType serviceType,
ISdlServiceListener sdlServiceListener
)
Add a service listener for a specific service type
public void addServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)
Method Parameters
- serviceType
- service type that the listener will be attached to
- sdlServiceListener
- listener for events that happen to the service
removeServiceListener(
SessionType serviceType,
ISdlServiceListener sdlServiceListener
)
Remote a service listener for a specific service type
public void removeServiceListener(SessionType serviceType,ISdlServiceListener sdlServiceListener)
Method Parameters
- serviceType
- service type that the listener was attached to
- sdlServiceListener
- service listener that was previously added for the service type
startVideoService(
VideoStreamingParameters parameters,
boolean encrypted,
boolean withPendingRestart
)
Starts the video streaming service
public void startVideoService(VideoStreamingParameters parameters,boolean encrypted,boolean withPendingRestart)
Method 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(
boolean encrypted
)
Starts the Audio streaming service
public void startAudioService(boolean encrypted)
Method Parameters
- encrypted
- flag to start this service with encryption or not
sendRPC(
RPCMessage message
)
Pass an RPC message through the proxy to be sent to the connected module
public void sendRPC(RPCMessage message)
Method Parameters
- message
- RPCMessage that should be sent to the module
sendRPCs(
java.util.List<? extends com.smartdevicelink.proxy.RPCMessage> rpcs,
OnMultipleRequestListener listener
)
Pass a list of RPC messages through the proxy to be sent to core
public void sendRPCs(java.util.List<? extends com.smartdevicelink.proxy.RPCMessage> rpcs,OnMultipleRequestListener listener)
Method Parameters
- rpcs
- List of RPC messages
- listener
- OnMultipleRequestListener that is called between requests and after all are processed
sendSequentialRPCs(
java.util.List<? extends com.smartdevicelink.proxy.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
public void sendSequentialRPCs(java.util.List<? extends com.smartdevicelink.proxy.RPCMessage> rpcs,OnMultipleRequestListener listener)
Method Parameters
- rpcs
- is the list of RPCMessages being sent
- listener
- listener for updates and completions
addOnRPCNotificationListener(
FunctionID notificationId,
OnRPCNotificationListener listener
)
Add an OnRPCNotificationListener for specified notification
public void addOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)
Method Parameters
- notificationId
- FunctionID of the notification that is to be listened for
- listener
- listener that should be added for the notification ID
removeOnRPCNotificationListener(
FunctionID notificationId,
OnRPCNotificationListener listener
)
Removes an OnRPCNotificationListener for specified notification
public boolean removeOnRPCNotificationListener(FunctionID notificationId,OnRPCNotificationListener listener)
Method Parameters
- notificationId
- FunctionID of the notification that was to be listened for
- listener
- listener that was previously added for the notification ID
addOnRPCRequestListener(
FunctionID functionID,
OnRPCRequestListener listener
)
Add an OnRPCRequestListener for specified request
public void addOnRPCRequestListener(FunctionID functionID,OnRPCRequestListener listener)
Method Parameters
- functionID
- FunctionID of the request that is to be listened for
- listener
- listener that should be added for the request ID
removeOnRPCRequestListener(
FunctionID functionID,
OnRPCRequestListener listener
)
Removes an OnRPCRequestListener for specified request
public boolean removeOnRPCRequestListener(FunctionID functionID,OnRPCRequestListener listener)
Method Parameters
- functionID
- FunctionID of the request that was to be listened for
- listener
- listener that was previously added for the request ID
addOnRPCListener(
FunctionID responseId,
OnRPCListener listener
)
Add an OnRPCResponseListener for specified response
public void addOnRPCListener(FunctionID responseId,OnRPCListener listener)
Method Parameters
- responseId
- FunctionID of the response that is to be listened for
- listener
- listener that should be added for the response ID
removeOnRPCListener(
FunctionID responseId,
OnRPCListener listener
)
Removes an OnRPCResponseListener for specified response
public boolean removeOnRPCListener(FunctionID responseId,OnRPCListener listener)
Method Parameters
- responseId
- FunctionID of the response that was to be listened for
- listener
- listener that was previously added for the response ID
getRegisterAppInterfaceResponse()
Get RegisterAppInterfaceResponse
public com.smartdevicelink.proxy.rpc.RegisterAppInterfaceResponse getRegisterAppInterfaceResponse()
isTransportForServiceAvailable(
SessionType serviceType
)
Check to see if a transport is available to start/use the supplied service.
public boolean isTransportForServiceAvailable(SessionType serviceType)
Method Parameters
- serviceType
- the session that should be checked for transport availability
getSdlMsgVersion()
Get the RPC specification version currently being used for the SDL messages
public com.smartdevicelink.proxy.rpc.SdlMsgVersion getSdlMsgVersion()
getProtocolVersion()
Get the protocol version of this session
public com.smartdevicelink.util.Version getProtocolVersion()
getMtu(
SessionType serviceType
)
Get the max payload size for a packet to be sent to the module
public long getMtu(SessionType serviceType)
Method Parameters
- serviceType
startRPCEncryption()
Start encrypted RPC service
public void startRPCEncryption()
getTaskmaster()
public Taskmaster getTaskmaster()
getSystemCapabilityManager()
public com.smartdevicelink.managers.lifecycle.SystemCapabilityManager getSystemCapabilityManager()
getPermissionManager()
public com.smartdevicelink.managers.permission.PermissionManager getPermissionManager()
View on GitHub.com