HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NET_WebSocketAPIHandlerImpl< Args > Class Template Reference

#include <NET_WebAPIHandler.h>

+ Inheritance diagram for NET_WebSocketAPIHandlerImpl< Args >:

Public Types

using Callback = std::function< void(NET_WebSocketAPIRequest &req, Args...)>
 
- Public Types inherited from NET_WebAPIHandler
using ParamDefault = UT_Optional< UT_StringHolder >
 
using ParamIdx = unsigned
 
using ParamArray = UT_Array< NET_Param >
 

Public Member Functions

 NET_WebSocketAPIHandlerImpl (const UT_StringHolder &name, const ParamArray &param_arr, Callback clb)
 
void call (NET_WebSocketAPIRequest &req, UT_JSONValueArray *args, UT_JSONValueMap *kwargs) override
 
 operator bool () const
 
bool isValid () const override
 
- Public Member Functions inherited from NET_WebAPIHandler
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)
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from NET_WebAPIHandler
 NET_WebAPIHandler (const UT_StringHolder &name, const ParamArray &param_arr)
 
- Protected Attributes inherited from NET_WebAPIHandler
UT_StringHolder myName
 
ParamArray myParams
 

Detailed Description

template<typename... Args>
class NET_WebSocketAPIHandlerImpl< Args >

Definition at line 477 of file NET_WebAPIHandler.h.

Member Typedef Documentation

template<typename... Args>
using NET_WebSocketAPIHandlerImpl< Args >::Callback = std::function<void(NET_WebSocketAPIRequest &req, Args...)>

Definition at line 481 of file NET_WebAPIHandler.h.

Constructor & Destructor Documentation

template<typename... Args>
NET_WebSocketAPIHandlerImpl< Args >::NET_WebSocketAPIHandlerImpl ( const UT_StringHolder name,
const ParamArray param_arr,
Callback  clb 
)
inline

Definition at line 483 of file NET_WebAPIHandler.h.

Member Function Documentation

template<typename... Args>
void NET_WebSocketAPIHandlerImpl< Args >::call ( NET_WebSocketAPIRequest req,
UT_JSONValueArray args,
UT_JSONValueMap kwargs 
)
inlineoverridevirtual

Reimplemented from NET_WebAPIHandler.

Definition at line 491 of file NET_WebAPIHandler.h.

template<typename... Args>
bool NET_WebSocketAPIHandlerImpl< Args >::isValid ( ) const
inlineoverridevirtual

Implements NET_WebAPIHandler.

Definition at line 519 of file NET_WebAPIHandler.h.

template<typename... Args>
NET_WebSocketAPIHandlerImpl< Args >::operator bool ( ) const
inline

Definition at line 518 of file NET_WebAPIHandler.h.


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