libhomegear-base  0.7
Base library for Homegear and Homegear family modules.
Public Member Functions | List of all members
BaseLib::Rpc::IWebserverEventSink Class Reference

This class provides hooks into the web server so get and post requests can be passed into family modules. More...

#include <IWebserverEventSink.h>

Inheritance diagram for BaseLib::Rpc::IWebserverEventSink:
BaseLib::IEventSinkBase

Public Member Functions

virtual ~IWebserverEventSink ()
 
virtual bool onGet (PServerInfo &serverInfo, Http &httpRequest, std::shared_ptr< TcpSocket > &socket, std::string &path)
 Called on every HTTP GET request processed by the web server. More...
 
virtual bool onPost (PServerInfo &serverInfo, Http &httpRequest, std::shared_ptr< TcpSocket > &socket, std::string &path)
 Called on every HTTP POST request processed by the web server. More...
 
- Public Member Functions inherited from BaseLib::IEventSinkBase
 IEventSinkBase ()
 
virtual ~IEventSinkBase ()
 

Detailed Description

This class provides hooks into the web server so get and post requests can be passed into family modules.

Constructor & Destructor Documentation

§ ~IWebserverEventSink()

virtual BaseLib::Rpc::IWebserverEventSink::~IWebserverEventSink ( )
inlinevirtual

Member Function Documentation

§ onGet()

virtual bool BaseLib::Rpc::IWebserverEventSink::onGet ( PServerInfo &  serverInfo,
Http &  httpRequest,
std::shared_ptr< TcpSocket > &  socket,
std::string &  path 
)
inlinevirtual

Called on every HTTP GET request processed by the web server.

Parameters
serverInfoInformation about the RPC server.
httpRequestThe http request received by the webserver.
socketThe socket to the client.
pathThe GET path called by the client.
Returns
Return true when the request was handled. When false is returned, the request will be handled by the web server.

§ onPost()

virtual bool BaseLib::Rpc::IWebserverEventSink::onPost ( PServerInfo &  serverInfo,
Http &  httpRequest,
std::shared_ptr< TcpSocket > &  socket,
std::string &  path 
)
inlinevirtual

Called on every HTTP POST request processed by the web server.

Parameters
serverInfoInformation about the RPC server.
httpRequestThe http request received by the webserver.
socketThe socket to the client.
pathThe POST path called by the client.
Returns
Return true when the request was handled. When false is returned, the request will be handled by the web server.
The documentation for this class was generated from the following file: