Package org.altbeacon.beacon.service

Class BeaconService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

org.altbeacon.beacon.service.BeaconService

All Implemented Interfaces:

ComponentCallbacks, ComponentCallbacks2

public class BeaconService
extends Service

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BeaconService.BeaconBinder	Class used for the client Binder.

Field Summary

Fields

Modifier and Type	Field	Description
static int	MSG_SET_SCAN_PERIODS
static int	MSG_START_MONITORING
static int	MSG_START_RANGING	Command to the service to display a message
static int	MSG_STOP_MONITORING
static int	MSG_STOP_RANGING
static int	MSG_SYNC_SETTINGS
static String	TAG

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	Description
BeaconService()

Method Summary

Modifier and Type	Method	Description
protected CycledLeScanCallback	getCycledLeScanCallback()
IBinder	onBind(Intent intent)	When binding to the service, we return an interface to our messenger for sending messages to the service.
void	onCreate()
void	onDestroy()
int	onStartCommand(Intent intent, int flags, int startId)
void	onTaskRemoved(Intent rootIntent)
boolean	onUnbind(Intent intent)
void	reloadParsers()
void	setScanPeriods(long scanPeriod, long betweenScanPeriod, boolean backgroundFlag)
void	startMonitoringBeaconsInRegion(Region region, Callback callback)
void	startRangingBeaconsInRegion(Region region, Callback callback)	methods for clients
void	stopMonitoringBeaconsInRegion(Region region)
void	stopRangingBeaconsInRegion(Region region)

Methods inherited from class android.app.Service

attachBaseContext, dump, getApplication, getForegroundServiceType, onConfigurationChanged, onLowMemory, onRebind, onStart, 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

TAG

public static final String TAG

See Also:

Constant Field Values

MSG_START_RANGING

public static final int MSG_START_RANGING

Command to the service to display a message

See Also:

Constant Field Values

MSG_STOP_RANGING

public static final int MSG_STOP_RANGING

See Also:

Constant Field Values

MSG_START_MONITORING

public static final int MSG_START_MONITORING

See Also:

Constant Field Values

MSG_STOP_MONITORING

public static final int MSG_STOP_MONITORING

See Also:

Constant Field Values

MSG_SET_SCAN_PERIODS

public static final int MSG_SET_SCAN_PERIODS

See Also:

Constant Field Values

MSG_SYNC_SETTINGS

public static final int MSG_SYNC_SETTINGS

See Also:

Constant Field Values

Constructor Detail

BeaconService

public BeaconService()

Method Detail

onCreate

@MainThread
public void onCreate()

Overrides:

onCreate in class Service

onStartCommand

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

Overrides:

onStartCommand in class Service

onBind

public IBinder onBind(Intent intent)

When binding to the service, we return an interface to our messenger for sending messages to the service.

Specified by:

onBind in class Service

onUnbind

public boolean onUnbind(Intent intent)

Overrides:

onUnbind in class Service

onDestroy

@MainThread
public void onDestroy()

Overrides:

onDestroy in class Service

onTaskRemoved

public void onTaskRemoved(Intent rootIntent)

Overrides:

onTaskRemoved in class Service

startRangingBeaconsInRegion

@MainThread
public void startRangingBeaconsInRegion(Region region,
                                        Callback callback)

methods for clients

stopRangingBeaconsInRegion

@MainThread
public void stopRangingBeaconsInRegion(Region region)

startMonitoringBeaconsInRegion

@MainThread
public void startMonitoringBeaconsInRegion(Region region,
                                           Callback callback)

stopMonitoringBeaconsInRegion

@MainThread
public void stopMonitoringBeaconsInRegion(Region region)

setScanPeriods

@MainThread
public void setScanPeriods(long scanPeriod,
                           long betweenScanPeriod,
                           boolean backgroundFlag)

reloadParsers

public void reloadParsers()

getCycledLeScanCallback

protected CycledLeScanCallback getCycledLeScanCallback()