com.smartdevicelink.session

Class SdlSession

java.lang.Object

com.smartdevicelink.session.BaseSdlSession

com.smartdevicelink.session.SdlSession

All Implemented Interfaces:

ISdlProtocol, ISecurityInitializedListener

public class SdlSession
extends BaseSdlSession

Field Summary

Fields inherited from class com.smartdevicelink.session.BaseSdlSession

acceptedVideoParams, desiredVideoParams, encryptedServices, sdlProtocol, sdlSecurity, serviceListeners, sessionId, sessionListener, transportConfig

Constructor Summary

Constructors

Constructor and Description
SdlSession(ISdlSessionListener listener, MultiplexTransportConfig config)
SdlSession(ISdlSessionListener listener, TCPTransportConfig config)

Method Summary

Modifier and Type	Method and Description
TransportType	getCurrentTransportType()
Version	getProtocolVersion() Get the current protocol version used by this session
protected SdlProtocolBase	getSdlProtocolImplementation()
void	onAuthTokenReceived(String authToken) A callback to indicate the SDL connected device has supplied an authentication token to this application.
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	shutdown(String info) A request made by the protocol layer to shutdown the layers above it.
void	startSession()

Methods inherited from class com.smartdevicelink.session.BaseSdlSession

addServiceListener, close, endService, extractSystemInfo, getAcceptedVideoParams, getActiveTransports, getDesiredVideoParams, getIsConnected, getMtu, getMtu, getSdlSecurity, getServiceListeners, getSessionId, getTransportConfig, isServiceProtected, isTransportForServiceAvailable, onProtocolError, onProtocolMessageReceived, onSecurityInitialized, onTransportDisconnected, processControlService, removeServiceListener, sendMessage, setAcceptedVideoParams, setDesiredVideoParams, setSdlSecurity, startService

Methods inherited from class java.lang.Object

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

Constructor Detail

SdlSession

public SdlSession(ISdlSessionListener listener,
                  MultiplexTransportConfig config)

SdlSession

public SdlSession(ISdlSessionListener listener,
                  TCPTransportConfig config)

Method Detail

getSdlProtocolImplementation

protected SdlProtocolBase getSdlProtocolImplementation()

Specified by:

getSdlProtocolImplementation in class BaseSdlSession

startSession

public void startSession()
                  throws SdlException

Overrides:

startSession in class BaseSdlSession

Throws:

SdlException

getCurrentTransportType

public TransportType getCurrentTransportType()

Overrides:

getCurrentTransportType in class BaseSdlSession

shutdown

public void shutdown(String info)

Description copied from interface: ISdlProtocol

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.

Specified by:

shutdown in interface ISdlProtocol

Overrides:

shutdown in class BaseSdlSession

Parameters:

info - human readable string on why the shutdown should occur

getProtocolVersion

public Version getProtocolVersion()

Get the current protocol version used by this session

Overrides:

getProtocolVersion in class BaseSdlSession

Returns:

Version that represents the Protocol version being used

onServiceStarted

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

Description copied from interface: ISdlProtocol

Called to indicate that a service has been started

Specified by:

onServiceStarted in interface ISdlProtocol

Specified by:

onServiceStarted in class BaseSdlSession

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

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

Description copied from interface: ISdlProtocol

This will get called when a service has ended

Specified by:

onServiceEnded in interface ISdlProtocol

Specified by:

onServiceEnded in class BaseSdlSession

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

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

Description copied from interface: ISdlProtocol

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.

Specified by:

onServiceError in interface ISdlProtocol

Specified by:

onServiceError in class BaseSdlSession

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

onAuthTokenReceived

public void onAuthTokenReceived(String authToken)

Description copied from interface: ISdlProtocol

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.

Specified by:

onAuthTokenReceived in interface ISdlProtocol

Overrides:

onAuthTokenReceived in class BaseSdlSession