NorthApi Class Reference

Public Member Functions
	NorthApi (NorthService *)
	North API class constructor. More...
	~NorthApi ()
	Destroy the API. More...
unsigned short	getListenerPort ()
	Return the port the service is listening on.
void	startServer ()
	Called on the API service thread. More...
void	attachDebugger (Response response, Request request)
	Invoke debugger attach on the north plugin. More...
void	detachDebugger (Response response, Request request)
	Invoke debugger detach on the north plugin. More...
void	setDebuggerBuffer (Response response, Request request)
	Invoke set debugger buffer size on the north plugin. More...
void	getDebuggerBuffer (Response response, Request request)
	Invoke get debugger buffer size on the north plugin. More...
void	isolateDebugger (Response response, Request request)
	Invoke isolate debugger handler on the north plugin. More...
void	suspendDebugger (Response response, Request request)
	Invoke suspend debugger handler on the north plugin. More...
void	stepDebugger (Response response, Request request)
	Invoke set debugger step command on the north plugin. More...
void	replayDebugger (Response response, Request request)
	Invoke debugger replay on the north plugin. More...
void	stateDebugger (Response response, Request request)
	Invoke debugger state on the north plugin. More...

Constructor & Destructor Documentation

NorthApi()

NorthApi::NorthApi

(

NorthService *

service

)

North API class constructor.

Parameters

service

The NorthService class this is the API for

~NorthApi()

NorthApi::~NorthApi

(

)

Destroy the API.

Stop the service and wait for the thread to terminate.

Member Function Documentation

attachDebugger()

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

Invoke debugger attach on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

detachDebugger()

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

Invoke debugger detach on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

getDebuggerBuffer()

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

Invoke get debugger buffer size on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

isolateDebugger()

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

Invoke isolate debugger handler on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request

replayDebugger()

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

Invoke debugger replay on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

setDebuggerBuffer()

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

Invoke set debugger buffer size on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request

startServer()

void NorthApi::startServer

(

)

Called on the API service thread.

Start the listener for HTTP requests

stateDebugger()

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

Invoke debugger state on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request - unused

stepDebugger()

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

Invoke set debugger step command on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request

suspendDebugger()

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

Invoke suspend debugger handler on the north plugin.

Parameters

response	The HTTP response
request	The HTTP request

---

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

• C/services/north/include/north_api.h
• C/services/north/north_api.cpp