Diff: source/main.h

Revision:

22:3af582d8e227

Child:

23:1976f83da84e

diff -r 32cd3bfde206 -r 3af582d8e227 source/main.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/source/main.h	Fri Aug 04 21:08:49 2017 +0000
@@ -0,0 +1,47 @@
+#pragma once
+
+// Include main application documentation.
+/** 
+
+@file main.cpp 
+
+@brief Contains application entry point and oulines core application design.
+
+@section design_overview_sec Design Overview
+
+The application is designed around a concept serial execution of high level tasks called jobs.  The 'scheduler' library is responsible for maintaining job schedules and ensuring that only one job is executing at any given time.  The Scheduler library for details on how it works.
+
+Each job is defined as a function that needs to be executed.  Currently the job function does not take any arguments.  It is planned that job may take a single argument of Scheduler::Appointment type.  Appointment provides all detailed data about job, its schedule and configurable per job instance parameters.
+
+Each job has its own unique context that's defined by its dependency on application specific services.  Examples of application services:
+
+@li LCE is a lightweight collection engine proxy.  LCE provides interface for sending CoAP data to headend (HE).
+
+@li Configuration service collects device specific configuration such as Serial Number and other parameters that can be changed through commands while device is running.
+
+@li Network stack service is defined by mbed OS itself through NetworkInterface class.  NetworkInterface is a good example of changing application functionality through change of interface implementation.  For example, it can use W5500 driver and it can be use a cell modem driver.
+
+@li Scheduler is a service object from design level point of view.  Scheduler can be passed as a context dependency to jobs that need to manipulate schedules.
+
+If job is implemented as a C++ class, then its service references should be instance variables.  C++ reference is recommended, because ass services are always expected to be not NULL.
+
+If job is implemented as a C module, then a separate initialize function is expected to set module level variables.
+
+In general failure to create a service object results in application termination as it results in cascading failure effect.
+
+@subsection Application Lifetime
+
+Once service objects are created, job scheduler is started on the main application thread.  Main thread is then blocked by waiting for scheduler to quit.  Unless there is a job that explicitly requests scheduler termination, the main thread will never unblock. 
+
+If scheduler stops, then main thread proceeds to the final stage of the application.  At this stage it is guaranteed that no job will be started, because scheduler has been stopped.  Thus, environment is fully under main function control and drastic changes can be applied such as firmware upgrades.
+
+@subsection Running of Other Parallel Threads
+
+The job is just another C function and thus there is nothing to stop function from creating its own thread after execution ends.  This is not denied, but a high level impact needs to be considered.
+
+For example, a receiving thread can be started for the life time of the socket.
+
+One consequence to consider is that creation of long running threads that go beyond job lifetime will make it more difficult to manage power consumption.  The recommended solution is to schedule another job through application scheduler from the job function itself. This way a single task at a time concept is not impacted and there is no concurrency complication.
+
+
+*/ 
\ No newline at end of file