com.smartdevicelink.transport

Class SdlRouterService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

com.smartdevicelink.transport.SdlRouterService

All Implemented Interfaces:

ComponentCallbacks, ComponentCallbacks2

public class SdlRouterService
extends Service

This class should not be modified by anyone outside of the approved contributors of the SmartDeviceLink project. This service is a central point of communication between hardware and the registered clients. It will multiplex a single transport to provide a connection for a theoretical infinite amount of SDL sessions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SdlRouterService.PacketWriteTask A runnable task for writing out packets.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY_AVOID_NOTIFICATION_CHANNEL_DELETE
static int	MESSAGE_DEVICE_NAME
static int	MESSAGE_LOG
static int	MESSAGE_READ
static int	MESSAGE_STATE_CHANGE Message types sent from the BluetoothReadService Handler
static int	MESSAGE_WRITE
static String	REGISTER_NEWER_SERVER_INSTANCE_ACTION
static String	REGISTER_WITH_ROUTER_ACTION
static HashMap<String,com.smartdevicelink.transport.SdlRouterService.RegisteredApp>	registeredApps
protected static int	ROUTER_SERVICE_VERSION_NUMBER NOTE: DO NOT MODIFY THIS UNLESS YOU KNOW WHAT YOU'RE DOING.
protected static String	SDL_DEVICE_STATUS_SHARED_PREFS Preference location where the service stores known SDL status based on device address
static String	SDL_NOTIFICATION_FAQS_PAGE
protected static String	SDL_ROUTER_SERVICE_PREFS Preference location where generic key/values can be stored

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_INCLUDE_CAPABILITIES, BIND_NOT_FOREGROUND, BIND_NOT_PERCEPTIBLE, BIND_WAIVE_PRIORITY, BIOMETRIC_SERVICE, BLOB_STORE_SERVICE, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, COMPANION_DEVICE_SERVICE, CONNECTIVITY_DIAGNOSTICS_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, CROSS_PROFILE_APPS_SERVICE, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, EUICC_SERVICE, FILE_INTEGRITY_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, IPSEC_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, ROLE_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_IMS_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, VPN_MANAGEMENT_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_RTT_RANGING_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
SdlRouterService()

Method Summary

Modifier and Type	Method and Description
boolean	bluetoothQuerryAndConnect() This function looks through the phones currently paired bluetooth devices If one of the devices' names contain "sync", or livio it will attempt to connect the RFCOMM And start SDL
void	cancelForegroundTimeOut()
void	closeSelf() This method is needed so that apps that choose not to implement this as a service as defined by Android, but rather just a simple class we have to know how to shut down.
protected void	deployNextRouterService() The method will attempt to start up the next router service in line based on the sorting criteria of best router service.
protected boolean	formatMessage(com.smartdevicelink.transport.SdlRouterService.RegisteredApp app, Message message) Formats the message for the app that is to receive it
protected boolean	getBooleanPref(String key, boolean defaultValue) Retrieves a boolean value for the given key in the SDL_ROUTER_SERVICE_PREFS
protected static com.smartdevicelink.transport.SdlRouterService.LocalRouterService	getLocalRouterService(Intent launchIntent, ComponentName name) Deprecated.
protected SdlRouterService.PacketWriteTask	getNextTask(TransportType transportType) Method for finding the next, highest priority write task from all connected apps.
protected boolean	hasSDLConnected(String address) Checks to see if a device address has connected to SDL before.
protected boolean	isFirstStatusCheck(String address) Checks to see if a device address has connected to SDL before.
IBinder	onBind(Intent intent)
void	onCreate()
void	onDestroy()
void	onPacketRead(SdlPacket packet)
int	onStartCommand(Intent intent, int flags, int startId)
void	onTransportConnected(TransportRecord record)
void	onTransportDisconnected(TransportRecord record)
void	onTransportError(TransportRecord transport, Bundle errorBundle)
boolean	onUnbind(Intent intent)
void	resetForegroundTimeOut(long delay)
boolean	sendPacketToRegisteredApp(SdlPacket packet) This will send the received packet to the registered service.
protected void	setRouterServiceExceptionHandler() This method will set a new UncaughtExceptionHandler for the current thread.
protected void	setSDLConnectedStatus(String address, boolean hasSDLConnected) Set the connection establishment status of the particular device
protected void	setSdlRouterServicePrefs(String key, boolean value) Set specific settings through key/value to the SDL_ROUTER_SERVICE_PREFS
boolean	shouldServiceRemainOpen(Intent intent) 1.
void	startUpSequence()
boolean	writeBytesToTransport(Bundle bundle)

Methods inherited from class android.app.Service

attachBaseContext, dump, getApplication, getForegroundServiceType, onConfigurationChanged, onLowMemory, onRebind, onStart, onTaskRemoved, onTrimMemory, startForeground, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

bindIsolatedService, bindService, bindService, bindServiceAsUser, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createAttributionContext, createConfigurationContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, createWindowContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getAttributionTag, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getDisplay, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainExecutor, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getOpPackageName, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startForegroundService, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver, updateServiceGroup

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, sendBroadcastWithMultiplePermissions, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

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

Field Detail

ROUTER_SERVICE_VERSION_NUMBER

protected static final int ROUTER_SERVICE_VERSION_NUMBER

NOTE: DO NOT MODIFY THIS UNLESS YOU KNOW WHAT YOU'RE DOING.

See Also:

Constant Field Values

REGISTER_NEWER_SERVER_INSTANCE_ACTION

public static final String REGISTER_NEWER_SERVER_INSTANCE_ACTION

See Also:

Constant Field Values

SDL_NOTIFICATION_FAQS_PAGE

public static final String SDL_NOTIFICATION_FAQS_PAGE

See Also:

Constant Field Values

REGISTER_WITH_ROUTER_ACTION

public static final String REGISTER_WITH_ROUTER_ACTION

See Also:

Constant Field Values

MESSAGE_STATE_CHANGE

public static final int MESSAGE_STATE_CHANGE

Message types sent from the BluetoothReadService Handler

See Also:

Constant Field Values

MESSAGE_READ

public static final int MESSAGE_READ

See Also:

Constant Field Values

MESSAGE_WRITE

public static final int MESSAGE_WRITE

See Also:

Constant Field Values

MESSAGE_DEVICE_NAME

public static final int MESSAGE_DEVICE_NAME

See Also:

Constant Field Values

MESSAGE_LOG

public static final int MESSAGE_LOG

See Also:

Constant Field Values

SDL_DEVICE_STATUS_SHARED_PREFS

protected static final String SDL_DEVICE_STATUS_SHARED_PREFS

Preference location where the service stores known SDL status based on device address

See Also:

Constant Field Values

SDL_ROUTER_SERVICE_PREFS

protected static final String SDL_ROUTER_SERVICE_PREFS

Preference location where generic key/values can be stored

See Also:

Constant Field Values

KEY_AVOID_NOTIFICATION_CHANNEL_DELETE

protected static final String KEY_AVOID_NOTIFICATION_CHANNEL_DELETE

See Also:

Constant Field Values

registeredApps

public static HashMap<String,com.smartdevicelink.transport.SdlRouterService.RegisteredApp> registeredApps

Constructor Detail

SdlRouterService

public SdlRouterService()

Method Detail

onBind

public IBinder onBind(Intent intent)

Specified by:

onBind in class Service

onUnbind

public boolean onUnbind(Intent intent)

Overrides:

onUnbind in class Service

formatMessage

protected boolean formatMessage(com.smartdevicelink.transport.SdlRouterService.RegisteredApp app,
                                Message message)

Formats the message for the app that is to receive it

Parameters:

app -

message -

Returns:

if the message should be sent or not

onCreate

public void onCreate()

Overrides:

onCreate in class Service

deployNextRouterService

protected void deployNextRouterService()

The method will attempt to start up the next router service in line based on the sorting criteria of best router service.

startUpSequence

public void startUpSequence()

setRouterServiceExceptionHandler

protected void setRouterServiceExceptionHandler()

This method will set a new UncaughtExceptionHandler for the current thread. The only purpose of the custom UncaughtExceptionHandler is to catch the rare occurrence that the a specific mobile device/OS can't properly handle the deletion and creation of the foreground notification channel that is necessary for foreground services after Android Oreo. The new UncaughtExceptionHandler will catch that specific exception and tell the main looper to continue forward. This still leaves the SdlRouterService killed, but prevents an ANR to the app that makes the startForegroundService call. It will set a flag that will prevent the channel from being deleted in the future and therefore avoiding this exception.

onStartCommand

public int onStartCommand(Intent intent,
                          int flags,
                          int startId)

Overrides:

onStartCommand in class Service

onDestroy

public void onDestroy()

Overrides:

onDestroy in class Service

resetForegroundTimeOut

public void resetForegroundTimeOut(long delay)

cancelForegroundTimeOut

public void cancelForegroundTimeOut()

shouldServiceRemainOpen

public boolean shouldServiceRemainOpen(Intent intent)

1. If the app has SDL shut off, shut down 2. if The app has an Alt Transport address or was started by one, stay open 3. If Bluetooth is off/NA shut down 4. Anything else

closeSelf

public void closeSelf()

This method is needed so that apps that choose not to implement this as a service as defined by Android, but rather just a simple class we have to know how to shut down.

onTransportConnected

public void onTransportConnected(TransportRecord record)

onTransportDisconnected

public void onTransportDisconnected(TransportRecord record)

onTransportError

public void onTransportError(TransportRecord transport,
                             Bundle errorBundle)

onPacketRead

public void onPacketRead(SdlPacket packet)

writeBytesToTransport

public boolean writeBytesToTransport(Bundle bundle)

sendPacketToRegisteredApp

public boolean sendPacketToRegisteredApp(SdlPacket packet)

This will send the received packet to the registered service. It will default to the single registered "foreground" app. This can be overridden to provide more specific functionality.

Parameters:

packet - the packet that is received

Returns:

whether or not the sending was successful

bluetoothQuerryAndConnect

public boolean bluetoothQuerryAndConnect()

This function looks through the phones currently paired bluetooth devices If one of the devices' names contain "sync", or livio it will attempt to connect the RFCOMM And start SDL

Returns:

a boolean if a connection was attempted

setSDLConnectedStatus

protected void setSDLConnectedStatus(String address,
                                     boolean hasSDLConnected)

Set the connection establishment status of the particular device

Parameters:

address - address of the device in question

hasSDLConnected - true if a connection has been established, false if not

isFirstStatusCheck

protected boolean isFirstStatusCheck(String address)

Checks to see if a device address has connected to SDL before.

Parameters:

address - the mac address of the device in quesiton

Returns:

if this is the first status check of this device

hasSDLConnected

protected boolean hasSDLConnected(String address)

Checks to see if a device address has connected to SDL before.

Parameters:

address - the mac address of the device in quesiton

Returns:

if an SDL connection has ever been established with this device

setSdlRouterServicePrefs

protected void setSdlRouterServicePrefs(String key,
                                        boolean value)

Set specific settings through key/value to the SDL_ROUTER_SERVICE_PREFS

Parameters:

key - the key of the pair to set in the preferences

value - boolean to attach to key in the preferences

getBooleanPref

protected boolean getBooleanPref(String key,
                                 boolean defaultValue)

Retrieves a boolean value for the given key in the SDL_ROUTER_SERVICE_PREFS

Parameters:

key - the string key that will be used to retrieve the boolean value

defaultValue - if they key does not exist or there is no value to be found, this is the value that will be returned

Returns:

the value associated with the supplied key or defaultValue if one does not exist

getLocalRouterService

@Deprecated
protected static com.smartdevicelink.transport.SdlRouterService.LocalRouterService getLocalRouterService(Intent launchIntent,
                                                                                                                     ComponentName name)

Deprecated.

getNextTask

protected SdlRouterService.PacketWriteTask getNextTask(TransportType transportType)

Method for finding the next, highest priority write task from all connected apps.

Returns:

the next task for writing out packets if one exists