helics  3.0.1
Public Member Functions | List of all members
helics::apps::WebServer Class Reference

#include <helicsWebServer.hpp>

+ Inheritance diagram for helics::apps::WebServer:

Public Member Functions

 WebServer (std::string server_name)
 
virtual void startServer (const Json::Value *val) override
 
virtual void stopServer () override
 
virtual void processArgs (const std::string &args) override
 
void enableHttpServer (bool enabled)
 
void enableWebSocketServer (bool enabled)
 

Additional Inherited Members

- Static Protected Member Functions inherited from helics::apps::TypedBrokerServer
static ActionMessage generateMessageResponse (const ActionMessage &rxcmd, portData &pdata, CoreType ctype)
 
static int getOpenPort (portData &pd)
 
static void assignPort (portData &pd, int pnumber, std::shared_ptr< Broker > &brk)
 
static void logMessage (const std::string &message)
 

Detailed Description

a virtual class to use as a base for broker servers of various types

Member Function Documentation

◆ enableHttpServer()

void helics::apps::WebServer::enableHttpServer ( bool  enabled)
inline

enable the HTTP server

◆ enableWebSocketServer()

void helics::apps::WebServer::enableWebSocketServer ( bool  enabled)
inline

enable the websocket server

◆ processArgs()

void helics::apps::WebServer::processArgs ( const std::string &  args)
overridevirtual

process any command line arguments

Reimplemented from helics::apps::TypedBrokerServer.

◆ startServer()

void helics::apps::WebServer::startServer ( const Json::Value *  val)
overridevirtual

start the server

Implements helics::apps::TypedBrokerServer.

◆ stopServer()

void helics::apps::WebServer::stopServer ( )
overridevirtual

stop the server

Implements helics::apps::TypedBrokerServer.


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