Fledge
An open source edge computing platform for industrial users
NorthService Class Reference

The NorthService class. More...

#include <north_service.h>

Inheritance diagram for NorthService:
Collaboration diagram for NorthService:

Public Member Functions

 NorthService (const std::string &name, const std::string &token="")
 Constructor for the north service.
 
virtual ~NorthService ()
 Destructor for the north service.
 
void start (std::string &coreAddress, unsigned short corePort)
 Start the north service.
 
void stop ()
 Stop the storage service/.
 
void shutdown ()
 Shutdown request.
 
void restart ()
 Restart request.
 
void configChange (const std::string &, const std::string &)
 Configuration change notification.
 
void configChildCreate (const std::string &, const std::string &, const std::string &)
 
void configChildDelete (const std::string &, const std::string &)
 
bool isRunning ()
 
const std::string & getName ()
 
const std::string & getPluginName ()
 
void pause ()
 
void release ()
 
bool write (const std::string &name, const std::string &value, const ControlDestination)
 
bool write (const std::string &name, const std::string &value, const ControlDestination, const std::string &arg)
 
int operation (const std::string &name, int paramCount, char *names[], char *parameters[], const ControlDestination)
 
int operation (const std::string &name, int paramCount, char *names[], char *parameters[], const ControlDestination, const std::string &arg)
 
void setDryRun ()
 
bool getDryRun ()
 
void alertFailures ()
 Raise an alert that we are having issues sending data. More...
 
void clearFailures ()
 Clear the failure alert for sending data. More...
 
- Public Member Functions inherited from ServiceAuthHandler
std::string & getName ()
 
std::string & getType ()
 
bool createSecurityCategories (ManagementClient *mgtClient, bool dryRun)
 Create "${service}Security" category with empty content. More...
 
bool updateSecurityCategory (const std::string &newCategory)
 Update the class objects from security category content update. More...
 
void setInitialAuthenticatedCaller ()
 Set initial value of enabled authentication.
 
void setAuthenticatedCaller (bool enabled)
 Set enabled authentication value. More...
 
bool getAuthenticatedCaller ()
 Return enabled authentication value. More...
 
bool AuthenticationMiddlewareACL (std::shared_ptr< HttpServer::Response > response, std::shared_ptr< HttpServer::Request > request, const std::string &serviceName, const std::string &serviceType)
 Authentication Middleware ACL check. More...
 
bool AuthenticationMiddlewareCommon (std::shared_ptr< HttpServer::Response > response, std::shared_ptr< HttpServer::Request > request, std::string &callerName, std::string &callerType)
 Authentication Middleware for Dispatcher service. More...
 
void AuthenticationMiddlewarePUT (std::shared_ptr< HttpServer::Response > response, std::shared_ptr< HttpServer::Request > request, std::function< void(std::shared_ptr< HttpServer::Response >, std::shared_ptr< HttpServer::Request >)> funcPUT)
 Authentication Middleware for PUT methods. More...
 
void refreshBearerToken ()
 Refresh the bearer token of the runnign service This routine is run by a thread started in createSecurityCategories. More...
 
void respond (std::shared_ptr< HttpServer::Response > response, const std::string &payload)
 
void respond (std::shared_ptr< HttpServer::Response > response, SimpleWeb::StatusCode code, const std::string &payload)
 
bool securityChange (const std::string &payload)
 Request security change action: More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ServiceAuthHandler
static ManagementClientgetMgmtClient ()
 
- Protected Attributes inherited from ServiceAuthHandler
std::string m_name
 
std::string m_type
 
- Static Protected Attributes inherited from ServiceAuthHandler
static ManagementClientm_mgtClient = NULL
 Initialise m_mgtClient object to NULL.
 

Detailed Description

The NorthService class.

This class is the core of the service that provides north side services to Fledge.

Member Function Documentation

◆ alertFailures()

void NorthService::alertFailures ( )

Raise an alert that we are having issues sending data.

We also write a warning to the system log to aid with debugging

◆ clearFailures()

void NorthService::clearFailures ( )

Clear the failure alert for sending data.

We clear the alert from the status bar and write a message to the system log


The documentation for this class was generated from the following files: