#include <api_handler.h>

Inheritance diagram for API_HANDLER:

Public Member Functions
	API_HANDLER ()

virtual	~API_HANDLER ()

API_RESULT	Handle (ApiRequest &aMsg)
	Attempt to handle the given API request, if a handler exists in this class for the message.

virtual void	onNetSettingsChanged ()
	Called on all registered handlers after project net settings (netclasses or netclass assignments) have been changed via the API.

void	requestNetSettingsNotification ()

bool	clearNetSettingsNotification ()
	Returns true if the notification had been requested at the time of the call.

void	setApiServer (KICAD_API_SERVER *aServer)
	Set by KICAD_API_SERVER::RegisterHandler; null when the handler is not registered.

KICAD_API_SERVER *	apiServer () const

Protected Types
typedef std::function< HANDLER_RESULT< ApiResponse >(ApiRequest &)>	REQUEST_HANDLER
	A handler for outer messages (envelopes) that will unpack to inner messages and call a specific handler function.

Protected Member Functions
template<class RequestType, class ResponseType, class HandlerType>
void	registerHandler (HANDLER_RESULT< ResponseType >(HandlerType::*aHandler)(const HANDLER_CONTEXT< RequestType > &))
	Registers an API command handler for the given message types.

Protected Attributes
std::map< std::string, REQUEST_HANDLER >	m_handlers
	Maps type name (without the URL prefix) to a handler method.

bool	m_notifyNetSettings = false

KICAD_API_SERVER *	m_apiServer = nullptr

Static Protected Attributes
static const wxString	m_defaultCommitMessage = _( "Modification from API" )

Private Member Functions
template<typename MessageType>
bool	tryUnpack (ApiRequest &aRequest, ApiResponse &aReply, MessageType &aDest)

Detailed Description

Definition at line 58 of file api_handler.h.

Member Typedef Documentation

◆ REQUEST_HANDLER

typedef std::function<HANDLER_RESULT<ApiResponse>( ApiRequest& )> API_HANDLER::REQUEST_HANDLER

protected

A handler for outer messages (envelopes) that will unpack to inner messages and call a specific handler function.

See also: registerHandler.

Definition at line 97 of file api_handler.h.

Constructor & Destructor Documentation

◆ API_HANDLER()

API_HANDLER::API_HANDLER ( )

inline

Definition at line 61 of file api_handler.h.

Referenced by API_HANDLER_COMMON::API_HANDLER_COMMON(), and API_HANDLER_EDITOR::API_HANDLER_EDITOR().

◆ ~API_HANDLER()

virtual API_HANDLER::~API_HANDLER ( )

inlinevirtual

Definition at line 63 of file api_handler.h.

Member Function Documentation

◆ apiServer()

KICAD_API_SERVER * API_HANDLER::apiServer ( ) const

inline

Definition at line 90 of file api_handler.h.

References m_apiServer.

Referenced by API_HANDLER_PCB::handleSaveDocumentAs(), and API_HANDLER_SCH::handleSaveDocumentAs().

◆ clearNetSettingsNotification()

bool API_HANDLER::clearNetSettingsNotification ( )

inline

Returns true if the notification had been requested at the time of the call.

Definition at line 81 of file api_handler.h.

References m_notifyNetSettings.

◆ Handle()

API_RESULT API_HANDLER::Handle ( ApiRequest & aMsg )

Attempt to handle the given API request, if a handler exists in this class for the message.

Parameters

aMsg	is a request to attempt to handle

Returns: a response to send to the client, or an appropriate error

Definition at line 30 of file api_handler.cpp.

References m_handlers.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ onNetSettingsChanged()

virtual void API_HANDLER::onNetSettingsChanged ( )

inlinevirtual

Called on all registered handlers after project net settings (netclasses or netclass assignments) have been changed via the API.

Reimplemented in API_HANDLER_PCB, and API_HANDLER_SCH.

Definition at line 76 of file api_handler.h.

◆ registerHandler()

template<class RequestType, class ResponseType, class HandlerType>

void API_HANDLER::registerHandler ( HANDLER_RESULT< ResponseType >(HandlerType::* aHandler )(const HANDLER_CONTEXT< RequestType > &) )

inlineprotected

Registers an API command handler for the given message types.

When an API request matching the given type comes in, the handler will be called and its response will be packed into an envelope for sending back to the API client.

If the given message does not unpack into the request type, an envelope is returned with status AS_BAD_REQUEST, which probably indicates corruption in the message.

Template Parameters

RequestType	is a protobuf message type containing a command
ResponseType	is a protobuf message type containing a command response
HandlerType	is the implied type of the API_HANDLER subclass

Parameters

aHandler is the handler function for the given request and response types

Definition at line 114 of file api_handler.h.

References HANDLER_CONTEXT< RequestMessageType >::ClientName, m_handlers, HANDLER_CONTEXT< RequestMessageType >::Request, and tryUnpack().

Referenced by API_HANDLER_BOARD::API_HANDLER_BOARD(), API_HANDLER_COMMON::API_HANDLER_COMMON(), API_HANDLER_EDITOR::API_HANDLER_EDITOR(), API_HANDLER_FOOTPRINT::API_HANDLER_FOOTPRINT(), API_HANDLER_LIBRARIES::API_HANDLER_LIBRARIES(), API_HANDLER_PCB::API_HANDLER_PCB(), API_HANDLER_SCH::API_HANDLER_SCH(), and API_HANDLER_SYMBOL::API_HANDLER_SYMBOL().

◆ requestNetSettingsNotification()

void API_HANDLER::requestNetSettingsNotification ( )

inline

Definition at line 78 of file api_handler.h.

References m_notifyNetSettings.

Referenced by API_HANDLER_COMMON::handleSetNetClassAssignments(), and API_HANDLER_COMMON::handleSetNetClasses().

◆ setApiServer()

void API_HANDLER::setApiServer ( KICAD_API_SERVER * aServer )

inline

Set by KICAD_API_SERVER::RegisterHandler; null when the handler is not registered.

Definition at line 89 of file api_handler.h.

References m_apiServer.

Referenced by KICAD_API_SERVER::DeregisterHandler(), and KICAD_API_SERVER::RegisterHandler().

◆ tryUnpack()

template<typename MessageType>

bool API_HANDLER::tryUnpack	(	ApiRequest &	aRequest,
		ApiResponse &	aReply,
		MessageType &	aDest )

inlineprivate

Definition at line 161 of file api_handler.h.

Referenced by registerHandler().

Member Data Documentation

◆ m_apiServer

KICAD_API_SERVER* API_HANDLER::m_apiServer = nullptr

protected

Definition at line 154 of file api_handler.h.

Referenced by apiServer(), and setApiServer().

◆ m_defaultCommitMessage

const wxString API_HANDLER::m_defaultCommitMessage = _( "Modification from API" )

staticprotected

Definition at line 156 of file api_handler.h.

Referenced by API_HANDLER_EDITOR::pushCurrentCommit().

◆ m_handlers

std::map<std::string, REQUEST_HANDLER> API_HANDLER::m_handlers

protected

Maps type name (without the URL prefix) to a handler method.

Definition at line 150 of file api_handler.h.

Referenced by Handle(), and registerHandler().

◆ m_notifyNetSettings

bool API_HANDLER::m_notifyNetSettings = false

protected

Definition at line 152 of file api_handler.h.

Referenced by clearNetSettingsNotification(), and requestNetSettingsNotification().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ REQUEST_HANDLER

Constructor & Destructor Documentation

◆ API_HANDLER()

◆ ~API_HANDLER()

Member Function Documentation

◆ apiServer()

◆ clearNetSettingsNotification()

◆ Handle()

◆ onNetSettingsChanged()

◆ registerHandler()

◆ requestNetSettingsNotification()

◆ setApiServer()

◆ tryUnpack()

Member Data Documentation

◆ m_apiServer

◆ m_defaultCommitMessage

◆ m_handlers

◆ m_notifyNetSettings