====== Client State ======

These functions allow you to monitor OFM's state in two ways : 
  - You can monitor its **startup** state : //clientState//.
  - You can monitor whether it's currently **communicating** with the server : //busy//.

===== Busy state =====

The busy state is expressed as a boolean (where true means busy).  Use ''addBusyChangedListener()'' and ''removeBusyChangedListener()'' to add or remove a listener.  Use ''isBusy()'' to retrieve the client's busy state. 

===== Client state =====

Client state is expressed as a mode string. 

^ State           ^ Meaning ^
| not_started         | Initial state. |
| timeout             | Timed out while loading settings or loading view. |
| failed_to_start     | Failed to initiate orbit client (server not found or unable to create session). |
| failed_no_config    | Failed to load map configuration (OrbitFlashMapConfig.xml) |
| started             | Set when client was succesfully created and first view starts loading. |

Use ''addClientStateChangedListener()'' and ''removeClientStateChangedListener()'' to add or remove //client state// change listeners.  Use ''getClientState()'' to retrieve the client state.