diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/afm-user-daemon.md | 47 | ||||
| -rw-r--r-- | docs/overview.md | 6 | ||||
| -rw-r--r-- | docs/quick-tutorial.md | 24 |
3 files changed, 47 insertions, 30 deletions
diff --git a/docs/afm-user-daemon.md b/docs/afm-user-daemon.md index ad625e9..cb54b10 100644 --- a/docs/afm-user-daemon.md +++ b/docs/afm-user-daemon.md @@ -24,8 +24,7 @@ applications on behalf of a user. Its main tasks are: - list current runnable or running applications - - stop (aka pause), continue (aka resume), terminate - a running instance of a given application + - pause, resume, terminate a running instance of a given application - transfer requests for installation/uninstallation of applications to the corresponding system daemon @@ -115,8 +114,8 @@ that it launched. When owning the right permissions, a client can get the list of running instances and details about a specific -running instance. It can also terminates, stops or -continues a given application. +running instance. It can also terminate, pause or +resume a given application. ### Installing and uninstalling applications ### @@ -400,7 +399,7 @@ The **afm-user-daemon** is listening on destination name ***org.AGL.afm.user*** at object path ***/org/AGL/afm/user*** on interface ***org.AGL.afm.user*** for following members: ***runnables***, ***detail***, ***start***, ***terminate***, -***stop***, ***continue***, ***runners***, ***state***, +***pause***, ***resume***, ***runners***, ***state***, ***install*** and ***uninstall***. D-Bus is mainly used for signaling and discovery. Its optimized @@ -469,13 +468,13 @@ Here is the summary of ***afm-util***: terminate the running instance rid - - **afm-util stop rid **: + - **afm-util pause rid **: - stop the running instance rid + pause the running instance rid - - **afm-util continue rid **: + - **afm-util resume rid **: - continue the previously rid + resume the previously paused rid - **afm-util state rid **: @@ -647,19 +646,37 @@ The field "mode" is a string equal to either "local" or "remote". #### Method org.AGL.afm.user.stop -**Description**: Stops the application attached to *runid* until terminate or continue. +Obsolete since 8th November 2016 (2016/11/08). +Kept for compatibility. -**Input**: The *runid* (integer) of the running instance to stop. +Use **org.AGL.afm.user.pause** instead. + +--- + +#### Method org.AGL.afm.user.continue + +Obsolete since 8th November 2016 (2016/11/08). +Kept for compatibility. + +Use **org.AGL.afm.user.resume** instead. + +--- + +#### Method org.AGL.afm.user.pause + +**Description**: Pauses the application attached to *runid* until terminate or resume. + +**Input**: The *runid* (integer) of the running instance to pause. **output**: the value 'true'. --- -#### Method org.AGL.afm.user.continue +#### Method org.AGL.afm.user.resume -**Description**: Continues the application attached to *runid* previously stopped. +**Description**: Resumes the application attached to *runid* previously paused. -**Input**: The *runid* (integer) of the running instance to continue. +**Input**: The *runid* (integer) of the running instance to resume. **output**: the value 'true'. @@ -674,7 +691,7 @@ The field "mode" is a string equal to either "local" or "remote". **output**: An object describing instance state. It contains: the runid (integer), the pids of the processes as an array starting with the group leader, the id of the running application (string), -the state of the application (string either: "starting", "running", "stopped"). +the state of the application (string either: "starting", "running", "paused"). Example of returned state: diff --git a/docs/overview.md b/docs/overview.md index d39e66e..99dcc1d 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -77,7 +77,7 @@ the dependencies and with minor architectural improvements for AGL. These components are **afm-system-daemon** and **afm-user-daemon**. They provides infrastructure for installing, uninstalling, -launching, terminating, stopping and resuming applications in +launching, terminating, pausing and resuming applications in a multi user secure environment. A third component exists in the framework, the binder **afb-daemon**. @@ -197,7 +197,7 @@ the components are: * ***afm-system-daemon***: in charge of installing and uninstalling applications. * ***afm-user-daemon***: in charge of listing applications, querying application details, - starting, terminating, stopping, resuming applications and their instances + starting, terminating, pausing, resuming applications and their instances for a given user context. * ***afb-binder***: in charge of serving resources and features through an @@ -219,7 +219,7 @@ to ensure security and privacy. It also includes features of reporting using audit features and by managing logs and alerts. The application framework manages the applications: -installing, uninstalling, starting, stopping, listing ... +installing, uninstalling, starting, pausing, listing ... The application framework uses the security model/framework to ensure the security and the privacy of the applications that diff --git a/docs/quick-tutorial.md b/docs/quick-tutorial.md index cd23c22..081dfe5 100644 --- a/docs/quick-tutorial.md +++ b/docs/quick-tutorial.md @@ -47,7 +47,7 @@ We can see that there are two daemons running: * **afm-system-daemon** runs with a system user 'afm' and is responsible for installing/uninstalling packages * **afm-user-daemon** runs as a user daemon (currently as root because it's the only real user on the target board) and is responsible for the whole lifecycle of the applications running inside the user session. -The application framework has a tool running on the Command Line Interface (CLI). Using the **afm-util** command, you can install, uninstall, list, run, stop ... applications. +The application framework has a tool running on the Command Line Interface (CLI). Using the **afm-util** command, you can install, uninstall, list, run, pause ... applications. To begin, run '**afm-util help**' to get a quick help on commands: @@ -75,16 +75,16 @@ To begin, run '**afm-util help**' to get a quick help on commands: start id start an instance of the widget of id kill rid - terminate rid terminate the running instance rid + terminate rid terminate the running instance rid stop rid - pause rid stop the running instance rid + pause rid pause the running instance rid resume rid - continue rid continue the previously rid + continue rid resume the previously rid status rid - state rid get status of the running instance rid + state rid get status of the running instance rid ### Install an application @@ -144,15 +144,15 @@ To check for running applications, just run: root@porter:~# afm-util ps [ { "runid": 1, "state": "running", "id": "webapps-annex@0.0" } ] -The 'runid' is the application instance ID and is used as an argument for the subcommands controlling the application runtime state (kill/stop/resume/status) +The 'runid' is the application instance ID and is used as an argument for the subcommands controlling the application runtime state (kill/pause/resume/status) -### Stop application -To stop the application that was just started (the one with RUNID 1), just run the stop command: +### Pause application +To pause the application that was just started (the one with RUNID 1), just run the pause command: root@porter:~# afm-util terminate 1 true -The application is now stopped, as confirmed by a list of running apps: +The application is now paused, as confirmed by a list of running apps: root@porter:~# afm-util ps [ ] @@ -172,7 +172,7 @@ Then list the installed apps to confirm the removal: afm-client: a sample HTML5 'Homescreen' --------------------------------------- -**afm-client** is a HTML5 UI that allows to install/uninstall applications as well as starting/stopping them as already demonstrated with afm-util. +**afm-client** is a HTML5 UI that allows to install/uninstall applications as well as starting/pausing them as already demonstrated with afm-util. The HTML5 UI is accessible remotely through this URL: http://[board_ip]:1234/opa?token=132456789 @@ -193,9 +193,9 @@ In the toolbar, click on the button representing the Rabbit application. You'll Click on the 'start' item: the application starts and should be visible as a webview on the target board display. Note that at this point, we could also run the application remotely, that is in the same browser as the Homescreen app. By default, the application framework is configured to run applications 'locally' on the board display. -### Stopping an application +### Pausing an application -In the Homescreen application, click again on the Rabbit application button, then select 'stop': the application then stops. +In the Homescreen application, click again on the Rabbit application button, then select 'pause': the application then pauses. ### Uninstalling an application |