Public Member Functions
	SouthApi (SouthService *)
	South API class constructor. More...

	~SouthApi ()
	Destroy the API. More...

unsigned short	getListenerPort ()
	Return the port the service is listening on.

void	setPoint (std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Response > response, std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Request > request)
	Implement the setPoint PUT request. More...

void	operation (std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Response > response, std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Request > request)
	Invoke an operation on the south plugin. More...

void	startServer ()
	Called on the API service thread. More...

Constructor & Destructor Documentation

◆ SouthApi()

SouthApi::SouthApi ( SouthService * service )

South API class constructor.

Parameters

service The SouthService class this is the API for

SouthApi::~SouthApi ( )

Destroy the API.

Stop the service and wait fo rthe thread to terminate.

void SouthApi::operation	(	std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Response >	response,
		std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Request >	request
	)

Invoke an operation on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request

void SouthApi::setPoint	(	std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Response >	response,
		std::shared_ptr< SimpleWeb::Server< SimpleWeb::HTTP >::Request >	request
	)

Implement the setPoint PUT request.

Caues the write operation on the south plugin to be called with eahc of the set point parameters

Parameters

response	The HTTP response
request	The HTTP request

void SouthApi::startServer ( )

Called on the API service thread.

Start the listener for HTTP requests

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