HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NET_WebAPIHandler Class Referenceabstract

#include <NET_WebAPIHandler.h>

+ Inheritance diagram for NET_WebAPIHandler:

Classes

class  NET_Param
 

Public Types

using ParamDefault = UT_Optional< UT_StringHolder >
 
using ParamIdx = unsigned
 
using ParamArray = UT_Array< NET_Param >
 

Public Member Functions

virtual ~NET_WebAPIHandler ()=default
 
virtual void exec (NET_HTTPRequest &req, NET_WebResponse &resp)
 
virtual void exec (NET_HTTPRequest &req, NET_WebResponse &resp, UT_JSONValueArray *args, UT_JSONValueMap *kwargs)
 
virtual void call (NET_WebSocketAPIRequest &req, UT_JSONValueArray *args, UT_JSONValueMap *kwargs)
 
const UT_StringHoldergetName () const
 
UT_Optional< ParamIdxgetParamIndex (const UT_String &name) const
 
UT_Optional< const
UT_StringHolder & > 
getParamDefault (const UT_String &name) const
 
 operator bool () const
 
virtual bool isValid () const =0
 

Protected Member Functions

 NET_WebAPIHandler (const UT_StringHolder &name, const ParamArray &param_arr)
 

Protected Attributes

UT_StringHolder myName
 
ParamArray myParams
 

Detailed Description

Definition at line 57 of file NET_WebAPIHandler.h.

Member Typedef Documentation

using NET_WebAPIHandler::ParamIdx = unsigned

Definition at line 75 of file NET_WebAPIHandler.h.

Constructor & Destructor Documentation

virtual NET_WebAPIHandler::~NET_WebAPIHandler ( )
virtualdefault
NET_WebAPIHandler::NET_WebAPIHandler ( const UT_StringHolder name,
const ParamArray param_arr 
)
protected

Member Function Documentation

virtual void NET_WebAPIHandler::call ( NET_WebSocketAPIRequest req,
UT_JSONValueArray args,
UT_JSONValueMap kwargs 
)
inlinevirtual

Reimplemented in NET_WebSocketAPIHandlerImpl< Args >.

Definition at line 92 of file NET_WebAPIHandler.h.

virtual void NET_WebAPIHandler::exec ( NET_HTTPRequest req,
NET_WebResponse resp 
)
inlinevirtual

Reimplemented in NET_WebAPIHandlerImpl< Args >.

Definition at line 80 of file NET_WebAPIHandler.h.

virtual void NET_WebAPIHandler::exec ( NET_HTTPRequest req,
NET_WebResponse resp,
UT_JSONValueArray args,
UT_JSONValueMap kwargs 
)
inlinevirtual

Reimplemented in NET_WebAPIHandlerImpl< Args >.

Definition at line 84 of file NET_WebAPIHandler.h.

const UT_StringHolder& NET_WebAPIHandler::getName ( ) const
inline

Definition at line 99 of file NET_WebAPIHandler.h.

UT_Optional<const UT_StringHolder &> NET_WebAPIHandler::getParamDefault ( const UT_String name) const
inline

Definition at line 111 of file NET_WebAPIHandler.h.

UT_Optional<ParamIdx> NET_WebAPIHandler::getParamIndex ( const UT_String name) const
inline

Definition at line 101 of file NET_WebAPIHandler.h.

virtual bool NET_WebAPIHandler::isValid ( ) const
pure virtual
NET_WebAPIHandler::operator bool ( ) const
inlineexplicit

Definition at line 127 of file NET_WebAPIHandler.h.

Member Data Documentation

UT_StringHolder NET_WebAPIHandler::myName
protected

Definition at line 134 of file NET_WebAPIHandler.h.

ParamArray NET_WebAPIHandler::myParams
protected

Definition at line 135 of file NET_WebAPIHandler.h.


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