com.smartdevicelink.protocol

Interface ISdlProtocol

All Known Implementing Classes:

BaseSdlSession, SdlSession

public interface ISdlProtocol

Method Summary

Modifier and Type	Method and Description
VideoStreamingParameters	getDesiredVideoParams() A method that should be implemented by the hosting class of the SdlProtocol instance that will return the desired video streaming parameters.
SdlSecurityBase	getSdlSecurity() A method that should be implemented by the hosting class of the SdlProtocol instance that will return the currently being used security library if any.
int	getSessionId() Method that the protocol layer will use to obtain the session ID
void	onAuthTokenReceived(String authToken) A callback to indicate the SDL connected device has supplied an authentication token to this application.
void	onProtocolError(String info, Exception e) Called to indicate that a protocol error was detected in received data.
void	onProtocolMessageReceived(ProtocolMessage msg) Called to indicate that a complete message (RPC, BULK, etc.) has been received.
void	onServiceEnded(SdlPacket packet, SessionType serviceType, int sessionID) This will get called when a service has ended
void	onServiceError(SdlPacket packet, SessionType serviceType, int sessionID, String error) If there is an error with starting or stopping the service or any other error this method will be called.
void	onServiceStarted(SdlPacket packet, SessionType serviceType, int sessionID, Version version, boolean isEncrypted) Called to indicate that a service has been started
void	onTransportDisconnected(String info, boolean altTransportAvailable, BaseTransportConfig transportConfig) Called when a transport disconnects
void	setAcceptedVideoParams(VideoStreamingParameters acceptedVideoParams) A callback that will be called when the video service has been successfully started and the streaming parameters have been negotiated.
void	shutdown(String info) A request made by the protocol layer to shutdown the layers above it.

Method Detail

onProtocolMessageReceived

void onProtocolMessageReceived(ProtocolMessage msg)

Called to indicate that a complete message (RPC, BULK, etc.) has been received.

Parameters:

msg - the message that was received

onServiceStarted

void onServiceStarted(SdlPacket packet,
                      SessionType serviceType,
                      int sessionID,
                      Version version,
                      boolean isEncrypted)

Called to indicate that a service has been started

Parameters:

packet - the control packet StartServiceACK received from the connected device

serviceType - the service type that has been started

sessionID - the session ID that this service has been started on

version - the protocol version used for this session and service

isEncrypted - if the service is encrypted

onServiceEnded

void onServiceEnded(SdlPacket packet,
                    SessionType serviceType,
                    int sessionID)

This will get called when a service has ended

Parameters:

packet - the packet received that ended this service

serviceType - the service type that has ended

sessionID - the id of the session that this service was operating on

onServiceError

void onServiceError(SdlPacket packet,
                    SessionType serviceType,
                    int sessionID,
                    String error)

If there is an error with starting or stopping the service or any other error this method will be called. This will also be called if the service was operating on a transport that has been disconnected.

Parameters:

packet - if there is a packet that caused this error it will be included, however this can be null.

serviceType - the service type that experienced the error

sessionID - the session ID that this service was associated with

error - a human readable string of the error

onProtocolError

void onProtocolError(String info,
                     Exception e)

Called to indicate that a protocol error was detected in received data.

Parameters:

info - a human readable string of the error

e - the exception if one occurred

getSessionId

int getSessionId()

Method that the protocol layer will use to obtain the session ID

Returns:

the session ID associated with the protocol instance

shutdown

void shutdown(String info)

A request made by the protocol layer to shutdown the layers above it. Likely due to the RPC service being shutdown or the primary transport disconnecting.

Parameters:

info - human readable string on why the shutdown should occur

onTransportDisconnected

void onTransportDisconnected(String info,
                             boolean altTransportAvailable,
                             BaseTransportConfig transportConfig)

Called when a transport disconnects

Parameters:

info - a human readable string including information on the disconnected transport

altTransportAvailable - a boolean flag indicating if there is another transport that can be used to connect with the SDL enabled device.

transportConfig - the previously supplied transport config

getSdlSecurity

SdlSecurityBase getSdlSecurity()

A method that should be implemented by the hosting class of the SdlProtocol instance that will return the currently being used security library if any.

Returns:

the security library to be used to encrypt/decrypt packets

getDesiredVideoParams

VideoStreamingParameters getDesiredVideoParams()

A method that should be implemented by the hosting class of the SdlProtocol instance that will return the desired video streaming parameters. These parameters will be requested if another component has requested the video streaming service to start.

Returns:

the developer supplied desired video streaming parameters

setAcceptedVideoParams

void setAcceptedVideoParams(VideoStreamingParameters acceptedVideoParams)

A callback that will be called when the video service has been successfully started and the streaming parameters have been negotiated. This should be called prior to the video service started callback.

Parameters:

acceptedVideoParams - the negotiated and accepted video parameters that should be used to stream to the SDL enabled device.

onAuthTokenReceived

void onAuthTokenReceived(String authToken)

A callback to indicate the SDL connected device has supplied an authentication token to this application. It will be called after the service start callback.

Parameters:

authToken -