com.smartdevicelink.transport

Class SdlBroadcastReceiver

java.lang.Object

android.content.BroadcastReceiver

com.smartdevicelink.transport.SdlBroadcastReceiver

public abstract class SdlBroadcastReceiver
extends BroadcastReceiver

Nested Class Summary

Nested classes/interfaces inherited from class android.content.BroadcastReceiver

BroadcastReceiver.PendingResult

Field Summary

Fields

Modifier and Type	Field and Description
static String	IS_TRANSPORT_CONNECTED
static String	LOCAL_ROUTER_SERVICE_DID_START_OWN
static String	LOCAL_ROUTER_SERVICE_EXTRA
static Vector<ComponentName>	runningBluetoothServicePackage
protected static String	SDL_ROUTER_SERVICE_CLASS_NAME
static String	TRANSPORT_GLOBAL_PREFS

Constructor Summary

Constructors

Constructor and Description
SdlBroadcastReceiver()

Method Summary

Modifier and Type	Method and Description
static ComponentName	consumeQueuedRouterService()
abstract Class<? extends SdlRouterService>	defineLocalSdlRouterClass() We need to define this for local copy of the Sdl Router Service class.
int	getRouterServiceVersion()
void	onReceive(Context context, Intent intent)
abstract void	onSdlEnabled(Context context, Intent intent) The developer will need to define exactly what should happen when Sdl is enabled.
protected static void	pingRouterService(Context context, String packageName, String className) Attempts to ping a running router service.
static void	queryForConnectedService(Context context) This call will reach out to all SDL related router services to check if they're connected.
protected static void	setForegroundExceptionHandler() This method will set a new UncaughtExceptionHandler for the current thread.

Methods inherited from class android.content.BroadcastReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras

Methods inherited from class java.lang.Object

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

Field Detail

SDL_ROUTER_SERVICE_CLASS_NAME

protected static final String SDL_ROUTER_SERVICE_CLASS_NAME

See Also:

Constant Field Values

LOCAL_ROUTER_SERVICE_EXTRA

public static final String LOCAL_ROUTER_SERVICE_EXTRA

See Also:

Constant Field Values

LOCAL_ROUTER_SERVICE_DID_START_OWN

public static final String LOCAL_ROUTER_SERVICE_DID_START_OWN

See Also:

Constant Field Values

TRANSPORT_GLOBAL_PREFS

public static final String TRANSPORT_GLOBAL_PREFS

See Also:

Constant Field Values

IS_TRANSPORT_CONNECTED

public static final String IS_TRANSPORT_CONNECTED

See Also:

Constant Field Values

runningBluetoothServicePackage

public static Vector<ComponentName> runningBluetoothServicePackage

Constructor Detail

SdlBroadcastReceiver

public SdlBroadcastReceiver()

Method Detail

getRouterServiceVersion

public int getRouterServiceVersion()

onReceive

@CallSuper
public void onReceive(Context context,
                                 Intent intent)

Specified by:

onReceive in class BroadcastReceiver

setForegroundExceptionHandler

protected static void setForegroundExceptionHandler()

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 SdlRouterService can't be started fast enough by the system after calling startForegroundService so the onCreate method doesn't get called before the foreground promise timer expires. 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.

pingRouterService

protected static void pingRouterService(Context context,
                                        String packageName,
                                        String className)

Attempts to ping a running router service. It does call startForegroundService so it is important to only call this as a ping if the service is already started.

Parameters:

context - A context to access Android system services through.

packageName - Package name for service to ping

className - Class name for service to ping

queryForConnectedService

public static void queryForConnectedService(Context context)

This call will reach out to all SDL related router services to check if they're connected. If a the router service is connected, it will react by pinging all clients. This receiver will then receive that ping and if the router service is trusted, the onSdlEnabled method will be called.

Parameters:

context -

consumeQueuedRouterService

public static ComponentName consumeQueuedRouterService()

defineLocalSdlRouterClass

public abstract Class<? extends SdlRouterService> defineLocalSdlRouterClass()

We need to define this for local copy of the Sdl Router Service class. It will be the main point of connection for Sdl enabled apps

Returns:

Return the local copy of SdlRouterService.class

onSdlEnabled

public abstract void onSdlEnabled(Context context,
                                  Intent intent)

The developer will need to define exactly what should happen when Sdl is enabled. This method will only get called when a Sdl session is initiated.

The most useful code here would be to start the activity or service that handles most of the Livio Connect code.

Parameters:

context - this is the context that was passed to this receiver when it was called.

intent - this is the intent that alerted this broadcast. Make sure to pass all extra it came with to your service/activity