otbr::rest::RestWebServer Class Reference

#include <src/rest/rest_web_server.hpp>

Inheritance diagram for otbr::rest::RestWebServer:

Public Member Functions
	RestWebServer (ControllerOpenThread &aNcp)
	~RestWebServer (void) override
void	Init (void)
void	Update (MainloopContext &aMainloop) override
void	Process (const MainloopContext &aMainloop) override

Detailed Description

This class implements a REST server.

Constructor & Destructor Documentation

RestWebServer()

otbr::rest::RestWebServer::RestWebServer

(

ControllerOpenThread &

aNcp

)

The constructor to initialize a REST server.

Parameters

[in]

aNcp

A reference to the NCP controller.

~RestWebServer()

otbr::rest::RestWebServer::~RestWebServer ( void  )

override

The destructor destroys the server instance.

Member Function Documentation

Init()

void otbr::rest::RestWebServer::Init

(

void

)

This method initializes the REST server.

Process()

void otbr::rest::RestWebServer::Process ( const MainloopContext &  aMainloop )

overridevirtual

This method processes mainloop events.

Parameters

[in]

aMainloop

A reference to the mainloop context.

Implements otbr::MainloopProcessor.

Update()

void otbr::rest::RestWebServer::Update ( MainloopContext &  aMainloop )

overridevirtual

This method updates the mainloop context.

Parameters

[in,out]

aMainloop

A reference to the mainloop to be updated.

Implements otbr::MainloopProcessor.

---

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

• src/rest/rest_web_server.hpp
• src/rest/rest_web_server.cpp