com.smartdevicelink.transport

Class TransportManagerBase

java.lang.Object

com.smartdevicelink.transport.TransportManagerBase

Direct Known Subclasses:

TCPTransportManager, TransportManager

public abstract class TransportManagerBase
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TransportManagerBase.TransportEventListener

Constructor Summary

Constructors

Constructor and Description
TransportManagerBase(BaseTransportConfig config, TransportManagerBase.TransportEventListener listener)

Method Summary

Modifier and Type	Method and Description
abstract void	close(long sessionId)
List<TransportRecord>	getConnectedTransports() Retrieves the currently connected transports
abstract TransportRecord	getTransportRecord(TransportType transportType, String address) Retrieve a transport record with the supplied params
abstract boolean	isConnected(TransportType transportType, String address) Check to see if a transport is connected.
boolean	isHighBandwidthAvailable()
void	requestNewSession(TransportRecord transportRecord) Base implementation does nothing and assumes it is not necessary.
void	requestSecondaryTransportConnection(byte sessionId, TransportRecord transportRecord)
abstract void	sendPacket(SdlPacket packet)
abstract void	start()
BaseTransportConfig	updateTransportConfig(BaseTransportConfig config)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportManagerBase

public TransportManagerBase(BaseTransportConfig config,
                            TransportManagerBase.TransportEventListener listener)

Method Detail

start

public abstract void start()

close

public abstract void close(long sessionId)

isConnected

public abstract boolean isConnected(TransportType transportType,
                                    String address)

Check to see if a transport is connected.

Parameters:

transportType - the transport to have its connection status returned. If `null` is passed in, all transports will be checked and if any are connected a true value will be returned.

address - the address associated with the transport type. If null, the first transport of supplied type will be used to return if connected.

Returns:

if a transport is connected based on included variables

getTransportRecord

public abstract TransportRecord getTransportRecord(TransportType transportType,
                                                   String address)

Retrieve a transport record with the supplied params

Parameters:

transportType - the transport to have its connection status returned.

address - the address associated with the transport type. If null, the first transport of supplied type will be returned.

Returns:

the transport record for the transport type and address if supplied

getConnectedTransports

public List<TransportRecord> getConnectedTransports()

Retrieves the currently connected transports

Returns:

the currently connected transports

isHighBandwidthAvailable

public boolean isHighBandwidthAvailable()

updateTransportConfig

public BaseTransportConfig updateTransportConfig(BaseTransportConfig config)

sendPacket

public abstract void sendPacket(SdlPacket packet)

requestNewSession

public void requestNewSession(TransportRecord transportRecord)

Base implementation does nothing and assumes it is not necessary. This method should be overridden in children classes that need to add a prerequest to their transports to make space ready for a new session.

Parameters:

transportRecord - the transport that the new session should be assigned to

requestSecondaryTransportConnection

public void requestSecondaryTransportConnection(byte sessionId,
                                                TransportRecord transportRecord)