OnboardTask Architecture Overview.md

OnboardTask Architecture Overview

Interfaces:

Code:

More details:

XServerIoTOnboardTask service settings

//Service display name
private const string ServiceDisplayName = "Xserver.OnboardTask";

//Task Handler Period (ms)
private const int TaskHandlerPeriod = 1000;

First Run

In the code below, the tasks required for the first run are performed.

 private async void Initialize()
 {
        await EventLogging.AddLogMessage(MessageType.Info, this.GetType().Name + " - " + ServiceDisplayName + " - " + "Start initializing...");

        try
        {
            //Initialize Http REST server
            await RestServer.HttpRESTServerStart();
            RestServer.ClientEvent += HttpRestServer_ClientRequestEvent;

            await EventLogging.AddLogMessage(MessageType.Info, this.GetType().Name + " - " + ServiceDisplayName + " - " + "Checking services...");
            _logger.LogInformation("Checking services...");
            bool exit = false;
            while (exit == false)
            {
                var com = await Services.ComIsInitialized();
                var data = await Services.DataIsInitialized();
                var core = await Services.CoreIsInitialized();
                if (com.Initialized == true && data.Initialized == true && core.Initialized == true)
                {
                    exit = true;
                    await EventLogging.AddLogMessage(MessageType.Info, this.GetType().Name + " - " + ServiceDisplayName + " - " + "Services are running.");
                    _logger.LogInformation("Services are running.");
                }
                await Task.Delay(5000);
            }

            //Todo: Write your initial code here
            //_logger.LogInformation("Debug message");
        }
        catch (Exception ex)
        {
            await EventLogging.AddLogMessage(MessageType.ExceptionError, this.GetType().Name + " - " + ServiceDisplayName + " - " + "Initialization exception error! Error: " + ex.Message);
        }

        await EventLogging.AddLogMessage(MessageType.Info, this.GetType().Name + " - " + ServiceDisplayName + " - " + "Finished initialization.");
 }

RESTAPI Calls

We can make our own RESTAPI interface that external applications can call. GET and POST calls are supported. This RESTAPI interface is used by the DATA service also, which invokes certain events (for example: Desired properties change callback).

 private async void HttpRestServer_ClientRequestEvent(object sender, HttpRestServerService.ClientRequestEventArgs e)
 {
        IO.NET.SimpleHttpServer.Result res = new IO.NET.SimpleHttpServer.Result();

        try
        {
            if (e.RequestMethod == RequestMethodType.GET)
            {
                //Todo: Type your code here
                //_logger.LogInformation("Debug message");
                // Example:
                //if (e.uriString.ToLower() == "/onboardtask/examplegeturi")
                //{
                //    string content = JsonConvert.SerializeObject(YourObject);
                //    res = await RestServer.ServerResponse(HTTPStatusCodes.OK, e.OStream, content);
                //}
            }
            else if (e.RequestMethod == RequestMethodType.POST)
            {
                //Todo: Type your code here
                //_logger.LogInformation("Debug message");
                // Example:
                //if (e.uriString.ToLower() == "/onboardtask/exampleposturi")
                //{  
                //    YourObject MyObj = JsonConvert.DeserializeObject<YourObject>(e.HttpContent);
                //    ....
                //    string content = JsonConvert.SerializeObject(answer);
                //    res = await RestServer.ServerResponse(HTTPStatusCodes.OK, e.OStream, content);
                //}
            }
            else
            {
                res = await RestServer.ServerResponse(HTTPStatusCodes.Not_Found, e.OStream, null);
            }
        }
        catch (Exception ex)
        {
            await EventLogging.AddLogMessage(MessageType.ExceptionError, this.GetType().Name + " - " + ServiceDisplayName + " - " + "Http REST server exception error! Error: " + ex.Message);
        }
}