org.safs.android.messenger.client

Class MessengerRunner

java.lang.Object

org.safs.android.messenger.client.MessengerRunner

All Implemented Interfaces:

java.lang.Runnable, MessengerListener, MultipleParcelListener, DebugListener, NamedListener

public class MessengerRunner
extends java.lang.Object
implements MessengerListener, java.lang.Runnable

It is used to handle the messages from 'TCP Messenger' in a separated Thread.

Since:

FEB 04, 2012 (Carl Nagle) Initial version
APR 25, 2013 (LeiWang) Handle message of big size.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

AbstractTestRunner, RobotiumTestRunner

Field Summary

Fields

Modifier and Type	Field and Description
(package private) CommandListener	commandListener
(package private) DebugListener	debugListener
(package private) int	iNotification
static java.lang.String	listenerName
(package private) boolean	messageHandled
(package private) MessengerHandler	messageHandler messageHandler is used to handle the received message from 'TCP Messenger'
(package private) android.os.Messenger	mMessenger mMessenger is used to receive message from message-service server
(package private) android.os.Messenger	mService mService is the messenger to be used to send out message to 'TCP Messenger'
(package private) java.lang.String	trd_message
(package private) java.util.Properties	trd_props

Constructor Summary

Constructors

Constructor and Description
MessengerRunner(android.os.Messenger mService)
MessengerRunner(android.os.Messenger mService, CommandListener commandListener)

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String message)
CommandListener	getCommandListener()
DebugListener	getDebugListener()
java.lang.String	getListenerName() Unique name to identify the listener.
android.os.Messenger	getmService()
void	onAllParcelsHaveBeenHandled(java.lang.String messageID)
void	onParcelHasBeenHandled(java.lang.String messageID, int index)
void	onReceiveDebug(java.lang.String message) A remote client has sent a Debug message to be logged by the listener.
void	onRemoteConnected()
void	onRemoteDisconnected()
void	onRemoteDispatchFile(java.lang.String message)
void	onRemoteDispatchProps(java.util.Properties props)
void	onRemoteEngineShutdown() Remote request/command to tell the engine to perform a normal shutdown.
void	onRemoteMessage(java.lang.String message)
void	onRemoteShutdown() Notification that the Remote Controller has shutdown and is no longer available.
void	onServiceShutdown() Notification that the Messenger Service has shutdown and is no longer available.
void	prepareNotification(int what) MessengerHandler preparing information for Thread switching.
void	run() Primary looping test thread remains active for as long as we are bound to a TCP Messenger Service.
boolean	sendDebug(java.lang.String message) Create and send a MSG_ENGINE_DEBUG message.
boolean	sendException(java.lang.String message) Create and send a MSG_ENGINE_EXCEPTION signaling the engine has detected and caught an Exception and is reporting that to the remote test controller.
boolean	sendMessage(java.lang.String message) Create and send a MSG_SERVER_MESSAGE signaling the engine has sent a custom/arbitrary message or response to the remote test controller.
boolean	sendReady() Create and send a MSG_ENGINE_READY signaling the engine is ready to process remote commands.
boolean	sendRegisterEngine() Create and send a ID_REGISTER_ENGINE signaling the engine is registered.
boolean	sendRunning() Create and send a MSG_ENGINE_RUNNING signaling the engine is processing the remote command.
(package private) boolean	sendServiceMessage(int what, java.lang.String message) Note: NEVER call debug() in this method or in the method it will call!!! It causes StackOverFlow.
boolean	sendServiceParcelAcknowledge(java.lang.String messageID, int index)
boolean	sendServiceProperties(int what, java.util.Properties props)
boolean	sendServiceResult(int statuscode, java.lang.String statusinfo) Create and send a MSG_ENGINE_RESULT message with the int statuscode and String statusinfo result from processing a previous command/dispatch.
boolean	sendServiceResult(MessageResult result)
boolean	sendServiceResult(java.util.Properties props) Create and send a MSG_ENGINE_RESULTPROPS message with the Properties result from processing a previous command/dispatch.
boolean	sendShutdown() Create and send a MSG_ENGINE_SHUTDOWN signaling the engine has or is in the process of shutting down.
boolean	sendUnRegisterEngine() Create and send a ID_UNREGISTER_ENGINE signaling the engine is un-registered.
void	setCommandListener(CommandListener commandListener)
void	setDebugListener(DebugListener debugListener)
void	setmService(android.os.Messenger mService)
boolean	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

listenerName

public static final java.lang.String listenerName

See Also:

Constant Field Values

messageHandled

boolean messageHandled

trd_props

java.util.Properties trd_props

trd_message

java.lang.String trd_message

iNotification

int iNotification

messageHandler

MessengerHandler messageHandler

messageHandler is used to handle the received message from 'TCP Messenger'

mMessenger

final android.os.Messenger mMessenger

mMessenger is used to receive message from message-service server

mService

android.os.Messenger mService

mService is the messenger to be used to send out message to 'TCP Messenger'

commandListener

CommandListener commandListener

debugListener

DebugListener debugListener

Constructor Detail

MessengerRunner

public MessengerRunner(android.os.Messenger mService)

MessengerRunner

public MessengerRunner(android.os.Messenger mService,
                       CommandListener commandListener)

Method Detail

getListenerName

public java.lang.String getListenerName()

Description copied from interface: NamedListener

Unique name to identify the listener.

Specified by:

getListenerName in interface NamedListener

Returns:

name of listener. Might be null.

getmService

public android.os.Messenger getmService()

setmService

public void setmService(android.os.Messenger mService)

getCommandListener

public CommandListener getCommandListener()

setCommandListener

public void setCommandListener(CommandListener commandListener)

getDebugListener

public DebugListener getDebugListener()

setDebugListener

public void setDebugListener(DebugListener debugListener)

debug

public void debug(java.lang.String message)

onReceiveDebug

public void onReceiveDebug(java.lang.String message)

Description copied from interface: DebugListener

A remote client has sent a Debug message to be logged by the listener.

Specified by:

onReceiveDebug in interface DebugListener

prepareNotification

public void prepareNotification(int what)

MessengerHandler preparing information for Thread switching.

Specified by:

prepareNotification in interface MessengerListener

onRemoteDispatchProps

public void onRemoteDispatchProps(java.util.Properties props)

Specified by:

onRemoteDispatchProps in interface MessengerListener

onRemoteDispatchFile

public void onRemoteDispatchFile(java.lang.String message)

Specified by:

onRemoteDispatchFile in interface MessengerListener

onRemoteMessage

public void onRemoteMessage(java.lang.String message)

Specified by:

onRemoteMessage in interface MessengerListener

onRemoteConnected

public void onRemoteConnected()

Specified by:

onRemoteConnected in interface MessengerListener

onRemoteDisconnected

public void onRemoteDisconnected()

Specified by:

onRemoteDisconnected in interface MessengerListener

onRemoteShutdown

public void onRemoteShutdown()

Notification that the Remote Controller has shutdown and is no longer available.

Specified by:

onRemoteShutdown in interface MessengerListener

onServiceShutdown

public void onServiceShutdown()

Notification that the Messenger Service has shutdown and is no longer available.

Specified by:

onServiceShutdown in interface MessengerListener

onRemoteEngineShutdown

public void onRemoteEngineShutdown()

Remote request/command to tell the engine to perform a normal shutdown.

Specified by:

onRemoteEngineShutdown in interface MessengerListener

run

public void run()

Primary looping test thread remains active for as long as we are bound to a TCP Messenger Service. Synchronizes with the Message handler waiting for new valid instructions then routes test actions according to the content of the data received via the Messenger.

Specified by:

run in interface java.lang.Runnable

start

public boolean start()

stop

public void stop()

sendServiceMessage

boolean sendServiceMessage(int what,
                           java.lang.String message)

Note: NEVER call debug() in this method or in the method it will call!!! It causes StackOverFlow. Create and send any String message through the service to the remote test controller. Most of the other methods of this pseudo-interface call this method with appropriate parameters.

Parameters:

what, - the message int flagging what kind of message we are sending.

message, - the actual message--which can be null.

Returns:

true on successfully sent

sendServiceResult

public boolean sendServiceResult(MessageResult result)

sendServiceResult

public boolean sendServiceResult(int statuscode,
                                 java.lang.String statusinfo)

Create and send a MSG_ENGINE_RESULT message with the int statuscode and String statusinfo result from processing a previous command/dispatch. This is largely used when we cannot send result Properties instead.

Returns:

true on successfully sent

See Also:

sendServiceResult(Properties)

sendServiceParcelAcknowledge

public boolean sendServiceParcelAcknowledge(java.lang.String messageID,
                                            int index)

sendServiceResult

public boolean sendServiceResult(java.util.Properties props)

Create and send a MSG_ENGINE_RESULTPROPS message with the Properties result from processing a previous command/dispatch. This is the preferred way to return results since more information can be transferred.

Returns:

true on successfully sent

See Also:

sendServiceResult(int,String)

sendServiceProperties

public boolean sendServiceProperties(int what,
                                     java.util.Properties props)

sendShutdown

public boolean sendShutdown()

Create and send a MSG_ENGINE_SHUTDOWN signaling the engine has or is in the process of shutting down.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

sendReady

public boolean sendReady()

Create and send a MSG_ENGINE_READY signaling the engine is ready to process remote commands.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

sendRunning

public boolean sendRunning()

Create and send a MSG_ENGINE_RUNNING signaling the engine is processing the remote command.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

sendDebug

public boolean sendDebug(java.lang.String message)

Create and send a MSG_ENGINE_DEBUG message. This allows the engine to route debug messages to external debug logging mechanisms handled by the remote test controller.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

sendMessage

public boolean sendMessage(java.lang.String message)

Create and send a MSG_SERVER_MESSAGE signaling the engine has sent a custom/arbitrary message or response to the remote test controller. It is the controller\engine developer that provides the logic to send and receive these messages and to know what to do with them when received.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

sendException

public boolean sendException(java.lang.String message)

Create and send a MSG_ENGINE_EXCEPTION signaling the engine has detected and caught an Exception and is reporting that to the remote test controller.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

sendRegisterEngine

public boolean sendRegisterEngine()

Create and send a ID_REGISTER_ENGINE signaling the engine is registered.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

sendUnRegisterEngine

public boolean sendUnRegisterEngine()

Create and send a ID_UNREGISTER_ENGINE signaling the engine is un-registered.

Returns:

true on successfully sent

See Also:

sendServiceMessage(int, String)

onAllParcelsHaveBeenHandled

public void onAllParcelsHaveBeenHandled(java.lang.String messageID)

Specified by:

onAllParcelsHaveBeenHandled in interface MultipleParcelListener

onParcelHasBeenHandled

public void onParcelHasBeenHandled(java.lang.String messageID,
                                   int index)

Specified by:

onParcelHasBeenHandled in interface MultipleParcelListener