SouthApi Class Reference

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...
void	attachDebugger (Response response, Request request)
	Invoke debugger attach on the south plugin. More...
void	detachDebugger (Response response, Request request)
	Invoke debugger detach on the south plugin. More...
void	setDebuggerBuffer (Response response, Request request)
	Invoke set debugger buffer size on the south plugin. More...
void	getDebuggerBuffer (Response response, Request request)
	Invoke get debugger buffer size on the south plugin. More...
void	isolateDebugger (Response response, Request request)
	Invoke isolate debugger handler on the south plugin. More...
void	suspendDebugger (Response response, Request request)
	Invoke suspend debugger handler on the south plugin. More...
void	stepDebugger (Response response, Request request)
	Invoke set debugger step command on the south plugin. More...
void	replayDebugger (Response response, Request request)
	Invoke debugger replay on the south plugin. More...
void	stateDebugger (Response response, Request request)
	Invoke debugger state on the south plugin. 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::~SouthApi

(

)

Destroy the API.

Stop the service and wait fo rthe thread to terminate.

Member Function Documentation

attachDebugger()

void SouthApi::attachDebugger	(	Response	response,
		Request	request
	)

Invoke debugger attach on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

detachDebugger()

void SouthApi::detachDebugger	(	Response	response,
		Request	request
	)

Invoke debugger detach on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

getDebuggerBuffer()

void SouthApi::getDebuggerBuffer	(	Response	response,
		Request	request
	)

Invoke get debugger buffer size on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

isolateDebugger()

void SouthApi::isolateDebugger	(	Response	response,
		Request	request
	)

Invoke isolate debugger handler on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request

operation()

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

replayDebugger()

void SouthApi::replayDebugger	(	Response	response,
		Request	request
	)

Invoke debugger replay on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

setDebuggerBuffer()

void SouthApi::setDebuggerBuffer	(	Response	response,
		Request	request
	)

Invoke set debugger buffer size on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request

setPoint()

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 each of the set point parameters

Parameters

response	The HTTP response
request	The HTTP request

startServer()

void SouthApi::startServer

(

)

Called on the API service thread.

Start the listener for HTTP requests

stateDebugger()

void SouthApi::stateDebugger	(	Response	response,
		Request	request
	)

Invoke debugger state on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

stepDebugger()

void SouthApi::stepDebugger	(	Response	response,
		Request	request
	)

Invoke set debugger step command on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request

suspendDebugger()

void SouthApi::suspendDebugger	(	Response	response,
		Request	request
	)

Invoke suspend debugger handler on the south plugin.

Parameters

response	The HTTP response
request	The HTTP request

---

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

• C/services/south/include/south_api.h
• C/services/south/south_api.cpp