BlowTorch
 All Classes Namespaces Files Functions Variables Enumerator Pages
Classes | Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
com.offsetnull.bt.service.StellarService Class Reference
Inheritance diagram for com.offsetnull.bt.service.StellarService:
Inheritance graph
[legend]
Collaboration diagram for com.offsetnull.bt.service.StellarService:
Collaboration graph
[legend]

Public Member Functions

void onLowMemory ()
 
final int onStartCommand (final Intent intent, final int flags, final int startId)
 
final void onCreate ()
 
final void onDestroy ()
 
final void doDisconnect (final Connection c)
 
final void dispatchXMLError (final String error) throws RemoteException
 
void dispatchSaveError (String error) throws RemoteException
 
void dispatchPluginSaveError (String plugin, String error) throws RemoteException
 
final void enableWifiKeepAlive ()
 
final void doVibrateBell ()
 
final void doNotifyBell (final String display, final String host, final int port)
 
final void doDisplayBell ()
 
final void disableWifiKeepAlive ()
 
final void dispatchToast (final String message, final boolean longtime)
 
final void dispatchDialog (final String message)
 
final void showConnectionNotification (final String display, final String host, final int port)
 
final void removeConnectionNotification (final String display)
 
final void doShutdown ()
 
final IBinder onBind (final Intent arg0)
 
final void setClutch (final String connection)
 
final void switchTo (final String display)
 
final void reloadWindows ()
 
final void sendRawDataToWindow (final byte[] data)
 
final boolean isWindowConnected ()
 
final void doClearAllButtons ()
 
final void doExecuteColorDebug (final Integer iarg)
 
final void doDirtyExit ()
 
final void doExecuteFullscreen (final boolean set)
 
final void doShowKeyboard (final String text, final boolean dopopup, final boolean doadd, final boolean doflush, final boolean doclear, final boolean doclose)
 
final void markWindowsDirty ()
 
final void markSettingsDirty ()
 
final void dispatchKeepLast (final Boolean value)
 
final void dispatchShowRegexWarning (final Boolean value)
 
final void doExecuteSetOrientation (final Integer value)
 
final void doExecuteKeepScreenOn (final Boolean value)
 
final void doExecuteFullscreenEditor (final Boolean value)
 
final void doExecuteUseSuggestions (final Boolean value)
 
final void doExecuteCompatibilityMode (final Boolean value)
 

Static Public Member Functions

static int getNotificationId ()
 

Static Protected Attributes

static final int MESSAGE_STARTUP = 0
 
static final int MESSAGE_NEWCONENCTION = 1
 
static final int MESSAGE_SWITCH = 2
 
static final int MESSAGE_RELOADSETTINGS = 3
 
static final int MESSAGE_STOPANR = 4
 

Detailed Description

The implementation of the background Service handler.

This class mostly just holds Connection objects and proxys commands made from the foreground window to the appropriate connection.

Member Function Documentation

final void com.offsetnull.bt.service.StellarService.disableWifiKeepAlive ( )

Disables the wifi keep alive.

final void com.offsetnull.bt.service.StellarService.dispatchDialog ( final String  message)

Utility method for dispatching a generic error looking dialog on the foreground window.

Parameters
messageThe message to display.
final void com.offsetnull.bt.service.StellarService.dispatchKeepLast ( final Boolean  value)

Implementation of the working method that sets the foreground window input bar's keep last setting.

Parameters
valueTrue for keeplast, false for clear when command is sent.
void com.offsetnull.bt.service.StellarService.dispatchPluginSaveError ( String  plugin,
String  error 
) throws RemoteException
void com.offsetnull.bt.service.StellarService.dispatchSaveError ( String  error) throws RemoteException
final void com.offsetnull.bt.service.StellarService.dispatchShowRegexWarning ( final Boolean  value)

Implementation of the working method that sets the foreground window trigger editor regex warning message state.

Parameters
valueTrue for show warning, false for no warning.
final void com.offsetnull.bt.service.StellarService.dispatchToast ( final String  message,
final boolean  longtime 
)

Utility method for dispatching a toast message to be displayed by the foreground window.

Parameters
messageThe message to show.
longtimetrue for Toast.LONG, false for Toast.SHORT
final void com.offsetnull.bt.service.StellarService.dispatchXMLError ( final String  error) throws RemoteException

Dispatches an error dialog in the foreground window.

Parameters
errorThe error message to show.
Exceptions
RemoteExceptionThrown when something has gone wrong with the aidl bridge.
final void com.offsetnull.bt.service.StellarService.doClearAllButtons ( )

The utility method to clear all buttons. I don't think that this is actually used, as this code has been folded into the plugin.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.StellarService.doDirtyExit ( )

Working implementation of the dirty exit. That is to close the app without closing the connections first.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.StellarService.doDisconnect ( final Connection  c)

The top level disconnect function.

This method is initated by a connection when it has disconnected. This method interfaces with the foreground window if appropriate to show the disconnection message.

Parameters
cThe connection that disconnected.

Here is the call graph for this function:

final void com.offsetnull.bt.service.StellarService.doDisplayBell ( )

Implementation of the visual bell callback. Called from a Connection.

final void com.offsetnull.bt.service.StellarService.doExecuteColorDebug ( final Integer  iarg)

Implementation of the working code to set the current color debug mode for the foreground window.

Parameters
iargThe color debug mode to enter.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.StellarService.doExecuteCompatibilityMode ( final Boolean  value)

Implementation of the method that sets the compatibility mode preference for the foreground window's editor.

Parameters
valueTrue to use compatibility mode, false to not.
final void com.offsetnull.bt.service.StellarService.doExecuteFullscreen ( final boolean  set)

Working implementation of the method that sets the fullscreen option in the foreground window.

Parameters
setTrue for fullscreen, false for not fullscreen.
final void com.offsetnull.bt.service.StellarService.doExecuteFullscreenEditor ( final Boolean  value)

Implementation of the method that sets the option for a fullscreen editor in the foreground window.

Parameters
valueTrue to use fullscreen editor, false to not.
final void com.offsetnull.bt.service.StellarService.doExecuteKeepScreenOn ( final Boolean  value)

Implementation of the method that sets the keep screen on in the foreground window.

Parameters
valueTrue, screen stays on, false screen does not stay on.
final void com.offsetnull.bt.service.StellarService.doExecuteSetOrientation ( final Integer  value)

Implementation of the method that sets the preferred orientation for the foreground window.

Parameters
valueInteger value, 1= portrait, 2=landscape, 3=auto
final void com.offsetnull.bt.service.StellarService.doExecuteUseSuggestions ( final Boolean  value)

Implementation of the method that sets the preference for weather or not to use suggestions in the foreground window editor.

Parameters
valueTrue to use suggestions, false to not.
final void com.offsetnull.bt.service.StellarService.doNotifyBell ( final String  display,
final String  host,
final int  port 
)

The implementation ofthe bell notifier. Connections will call this.

Parameters
displayThe display name of the calling connection.
hostThe host name of the calling connection.
portThe port number for the calling connection.

Here is the call graph for this function:

final void com.offsetnull.bt.service.StellarService.doShowKeyboard ( final String  text,
final boolean  dopopup,
final boolean  doadd,
final boolean  doflush,
final boolean  doclear,
final boolean  doclose 
)

Working implementation of the method that pops up the keyboard in the foreground window.

Parameters
textThe text to add to the input bar.
dopopupTrue to pop up the keyboard.
doaddTrue to apppend text to the input bar.
doflushTrue to flush the input bar.
doclearTrue to clear the input bar.
docloseTrue to close the keyboard.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.StellarService.doShutdown ( )

The generic top level shutdown routine. Attempts to gracefully shut down all active connections.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.StellarService.doVibrateBell ( )

The implementation of the bell vibrator. Connections will call this.

final void com.offsetnull.bt.service.StellarService.enableWifiKeepAlive ( )

Enables Wifi KeepAlive.

static int com.offsetnull.bt.service.StellarService.getNotificationId ( )
static

Gets a new unique id for notifications. Always increments the value so it will be unique with each call.

Returns
the new unique identifier number.

Here is the caller graph for this function:

final boolean com.offsetnull.bt.service.StellarService.isWindowConnected ( )

Utility method for checking weather or not the window is showing.

Returns
true if the window is showing, false if the window is not showing.
final void com.offsetnull.bt.service.StellarService.markSettingsDirty ( )

Utility method to mark the foreground window (non-window) settings as dirty so they are reloaded.

final void com.offsetnull.bt.service.StellarService.markWindowsDirty ( )

Utility method to mark the foreground window settings as dirty, so they are reloaded at next opportunity.

final IBinder com.offsetnull.bt.service.StellarService.onBind ( final Intent  arg0)

The implementation of Service.onBind().

Parameters
arg0the Intent that was used to start this service.
Returns
the IBinder to give to the foreground process that is requesting to bind.
See Also
Android AIDL docs.
final void com.offsetnull.bt.service.StellarService.onCreate ( )

The implementation of the onCreate() Service method.

final void com.offsetnull.bt.service.StellarService.onDestroy ( )

Implementation of the Service.onDestroy() method.

Here is the call graph for this function:

void com.offsetnull.bt.service.StellarService.onLowMemory ( )
final int com.offsetnull.bt.service.StellarService.onStartCommand ( final Intent  intent,
final int  flags,
final int  startId 
)

Implementation of onStartCommand(...) Service function.

Parameters
intentsee docs
flagssee docs
startIdsee docs
Returns
see docs
See Also
Android Documentation for Service.onStartCommand()

Here is the call graph for this function:

final void com.offsetnull.bt.service.StellarService.reloadWindows ( )

Generic method to make the currently active connection reload its windows.

final void com.offsetnull.bt.service.StellarService.removeConnectionNotification ( final String  display)

Called by a connection when disconnected to remove the associated notification.

Parameters
displayThe display name of the disconnected connection.
final void com.offsetnull.bt.service.StellarService.sendRawDataToWindow ( final byte[]  data)

Dispatches data to the foreground window.

Parameters
datathe data to send.
final void com.offsetnull.bt.service.StellarService.setClutch ( final String  connection)

Setter method for mConnectionClutch.

Parameters
connectionThe new connection to make active.

Here is the caller graph for this function:

final void com.offsetnull.bt.service.StellarService.showConnectionNotification ( final String  display,
final String  host,
final int  port 
)

Method called when a connection has connected successfully.

This method coordinates with the multi-connection system to ensure that at least one notification is used for the startForeground(...) method.

Parameters
displayThe display name of the connection.
hostThe host name of the connection.
portThe port number of the connection.

Here is the call graph for this function:

final void com.offsetnull.bt.service.StellarService.switchTo ( final String  display)

Utility method to switch the active connection.

Parameters
displayThe display name of the connection to switch to.

Here is the call graph for this function:

Member Data Documentation

final int com.offsetnull.bt.service.StellarService.MESSAGE_NEWCONENCTION = 1
staticprotected

Message constant indicating a new connection launch.

final int com.offsetnull.bt.service.StellarService.MESSAGE_RELOADSETTINGS = 3
staticprotected

Message constant indicating that the active connection should reload its settings.

final int com.offsetnull.bt.service.StellarService.MESSAGE_STARTUP = 0
staticprotected

Message constant indicating system startup.

final int com.offsetnull.bt.service.StellarService.MESSAGE_STOPANR = 4
staticprotected

Not really sure what this is for but I think it had something to do with debugging an ANR in the service.

final int com.offsetnull.bt.service.StellarService.MESSAGE_SWITCH = 2
staticprotected

Message constant indicating that the active connection should switch to a different connection.


The documentation for this class was generated from the following file: