HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NET_WebTaskFactory Class Reference

This is used to tell the web server what kind of task to create. More...

#include <NET_WebTaskHandler.h>

+ Inheritance diagram for NET_WebTaskFactory:

Public Types

using ProtocolId = uint32
 

Public Member Functions

virtual ~NET_WebTaskFactory ()=default
 
virtual NET_WebTaskHandlerPtr create (NET_WebEndpoint &ep) const
 
virtual NET_WebTaskHandlerPtr createByProtocol (NET_WebEndpoint &ep, ProtocolId Id, const char *url=nullptr) const
 
virtual ProtocolId determineProtocol (NET_WebEndpoint &ep) const
 
virtual bool supportsProtocol (ProtocolId id, const char *path=nullptr) const
 
bool supportsProtocol (NET_WebEndpoint &ep) const
 

Static Public Attributes

static constexpr ProtocolId InvalidProtocolId = 0
 
static constexpr ProtocolId HttpProtocolId = UT_StringLit("http").hash()
 
static constexpr ProtocolId WSProtocolId = UT_StringLit("websocket").hash()
 

Protected Member Functions

 NET_WebTaskFactory ()=default
 

Detailed Description

This is used to tell the web server what kind of task to create.

Definition at line 90 of file NET_WebTaskHandler.h.

Member Typedef Documentation

Definition at line 93 of file NET_WebTaskHandler.h.

Constructor & Destructor Documentation

virtual NET_WebTaskFactory::~NET_WebTaskFactory ( )
virtualdefault
NET_WebTaskFactory::NET_WebTaskFactory ( )
protecteddefault

Member Function Documentation

virtual NET_WebTaskHandlerPtr NET_WebTaskFactory::create ( NET_WebEndpoint ep) const
inlinevirtual

Definition at line 99 of file NET_WebTaskHandler.h.

virtual NET_WebTaskHandlerPtr NET_WebTaskFactory::createByProtocol ( NET_WebEndpoint ep,
ProtocolId  Id,
const char *  url = nullptr 
) const
inlinevirtual

Reimplemented in NET_GenericWebTaskFactory< T >, and NET_WebSocketFactory.

Definition at line 104 of file NET_WebTaskHandler.h.

virtual ProtocolId NET_WebTaskFactory::determineProtocol ( NET_WebEndpoint ep) const
inlinevirtual

Definition at line 111 of file NET_WebTaskHandler.h.

virtual bool NET_WebTaskFactory::supportsProtocol ( ProtocolId  id,
const char *  path = nullptr 
) const
inlinevirtual

Reimplemented in NET_WebSocketFactory, and NET_GenericWebTaskFactory< T >.

Definition at line 119 of file NET_WebTaskHandler.h.

bool NET_WebTaskFactory::supportsProtocol ( NET_WebEndpoint ep) const
inline

Definition at line 124 of file NET_WebTaskHandler.h.

Member Data Documentation

constexpr ProtocolId NET_WebTaskFactory::HttpProtocolId = UT_StringLit("http").hash()
static

Definition at line 95 of file NET_WebTaskHandler.h.

constexpr ProtocolId NET_WebTaskFactory::InvalidProtocolId = 0
static

Definition at line 94 of file NET_WebTaskHandler.h.

constexpr ProtocolId NET_WebTaskFactory::WSProtocolId = UT_StringLit("websocket").hash()
static

Definition at line 96 of file NET_WebTaskHandler.h.


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