com.smartdevicelink.protocol

Class SdlProtocolBase

java.lang.Object

com.smartdevicelink.protocol.SdlProtocolBase

Direct Known Subclasses:

SdlProtocol

public class SdlProtocolBase
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SdlProtocolBase.MessageFrameAssembler

Field Summary

Fields

Modifier and Type	Field and Description
static int	V1_HEADER_SIZE Original header size based on version 1.0.0 only
static int	V1_V2_MTU_SIZE
static int	V2_HEADER_SIZE Larger header size that is used by versions 2.0.0 and up
static int	V3_V4_MTU_SIZE

Constructor Summary

Constructors

Constructor and Description
SdlProtocolBase(ISdlProtocol iSdlProtocol, BaseTransportConfig config)

Method Summary

Modifier and Type	Method and Description
void	endService(SessionType serviceType, byte sessionID)
void	endSession(byte sessionID)
List<TransportRecord>	getActiveTransports() This method will return copy of active transports
protected SdlProtocolBase.MessageFrameAssembler	getFrameAssemblerForFrame(SdlPacket packet)
int	getMtu() Retrieves the max payload size for a packet to be sent to the module
long	getMtu(SessionType type)
Version	getProtocolVersion()
protected void	handlePacketReceived(SdlPacket packet)
protected void	handlePacketToSend(SdlPacket packet) SdlPacket should have included payload at this point.
protected void	handleProtocolError(String string, Exception ex)
protected void	handleProtocolHeartbeat(SessionType sessionType, byte sessionID)
protected void	handleProtocolSessionNAKed(SdlPacket packet, SessionType serviceType)
protected void	handleServiceEnded(SdlPacket packet, SessionType sessionType)
protected void	handleServiceEndedNAK(SdlPacket packet, SessionType serviceType) This method handles the end of a protocol session.
protected void	handleStartServiceACK(SdlPacket packet, SessionType serviceType) This method handles the startup of a protocol session.
boolean	isConnected()
boolean	isTransportForServiceAvailable(SessionType serviceType) Check to see if a transport is available to start/use the supplied service.
protected void	printActiveTransports() For logging purposes, prints active services on each connected transport
protected void	printSecondaryTransportDetails(List<String> secondary, List<Integer> audio, List<Integer> video)
protected void	reset() Resets the protocol to init status
void	resetSession() Deprecated.
void	sendMessage(ProtocolMessage protocolMsg)
protected void	setVersion(byte version) This method will set the major protocol version that we should use.
void	start()
void	startService(SessionType serviceType, byte sessionID, boolean isEncrypted)

Methods inherited from class java.lang.Object

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

Field Detail

V1_HEADER_SIZE

public static final int V1_HEADER_SIZE

Original header size based on version 1.0.0 only

See Also:

Constant Field Values

V2_HEADER_SIZE

public static final int V2_HEADER_SIZE

Larger header size that is used by versions 2.0.0 and up

See Also:

Constant Field Values

V1_V2_MTU_SIZE

public static final int V1_V2_MTU_SIZE

See Also:

Constant Field Values

V3_V4_MTU_SIZE

public static final int V3_V4_MTU_SIZE

See Also:

Constant Field Values

Constructor Detail

SdlProtocolBase

public SdlProtocolBase(@NonNull
                       ISdlProtocol iSdlProtocol,
                       @NonNull
                       BaseTransportConfig config)

Method Detail

start

public void start()

getMtu

public int getMtu()

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

Returns:

the max transfer unit

getMtu

public long getMtu(SessionType type)

resetSession

@Deprecated
public void resetSession()

Deprecated.

isConnected

public boolean isConnected()

reset

protected void reset()

Resets the protocol to init status

printActiveTransports

protected void printActiveTransports()

For logging purposes, prints active services on each connected transport

printSecondaryTransportDetails

protected void printSecondaryTransportDetails(List<String> secondary,
                                              List<Integer> audio,
                                              List<Integer> video)

isTransportForServiceAvailable

public boolean isTransportForServiceAvailable(@NonNull
                                              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.

getProtocolVersion

public Version getProtocolVersion()

setVersion

protected void setVersion(byte version)

This method will set the major protocol version that we should use. It will also set the default MTU based on version.

Parameters:

version - major version to use

endSession

public void endSession(byte sessionID)

sendMessage

public void sendMessage(ProtocolMessage protocolMsg)

handlePacketReceived

protected void handlePacketReceived(SdlPacket packet)

getFrameAssemblerForFrame

protected SdlProtocolBase.MessageFrameAssembler getFrameAssemblerForFrame(SdlPacket packet)

startService

public void startService(SessionType serviceType,
                         byte sessionID,
                         boolean isEncrypted)

endService

public void endService(SessionType serviceType,
                       byte sessionID)

handlePacketToSend

protected void handlePacketToSend(SdlPacket packet)

SdlPacket should have included payload at this point.

Parameters:

packet - packet that will be sent to the router service

handleServiceEndedNAK

protected void handleServiceEndedNAK(SdlPacket packet,
                                     SessionType serviceType)

This method handles the end of a protocol session. A callback is sent to the protocol listener.

handleServiceEnded

protected void handleServiceEnded(SdlPacket packet,
                                  SessionType sessionType)

handleStartServiceACK

protected void handleStartServiceACK(SdlPacket packet,
                                     SessionType serviceType)

This method handles the startup of a protocol session. A callback is sent to the protocol listener.

Parameters:

packet - StarServiceACK packet

serviceType - the service type that has just been started

handleProtocolSessionNAKed

protected void handleProtocolSessionNAKed(SdlPacket packet,
                                          SessionType serviceType)

handleProtocolError

protected void handleProtocolError(String string,
                                   Exception ex)

handleProtocolHeartbeat

protected void handleProtocolHeartbeat(SessionType sessionType,
                                       byte sessionID)

getActiveTransports

public List<TransportRecord> getActiveTransports()

This method will return copy of active transports

Returns:

a list of active transports