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

Holds information about the port. In HTTP case this will hold any handlers that are bound to that port. More...

#include <NET_WebServer.h>

Public Member Functions

 NET_PortInformation ()
 
virtual ~NET_PortInformation ()=default
 
void setPort (int port)
 
SYS_NO_DISCARD_RESULT int port () const
 
SYS_NO_DISCARD_RESULT bool isValid () const
 
bool handle (NET_HTTPWebTaskHandler *handler)
 
bool handleWebSocket (NET_WebSocketHandler *handler, const UT_StringHolder &msg)
 
void routeRequest (NET_HTTPRequest &req, NET_WebResponse &resp) const
 
void insertHandler (const NET_UrlHandlerPtr &handler)
 
NET_WebSocketAPIRouterwebSocketRouter ()
 

Static Public Member Functions

static bool isOriginAccepted (const UT_StringArray &whitelist, const UT_Url &origin)
 

Public Attributes

UT_StringArray myOriginWhitelist
 

Friends

class NET_WebServer
 

Detailed Description

Holds information about the port. In HTTP case this will hold any handlers that are bound to that port.

Definition at line 85 of file NET_WebServer.h.

Constructor & Destructor Documentation

NET_PortInformation::NET_PortInformation ( )
inline

Definition at line 88 of file NET_WebServer.h.

virtual NET_PortInformation::~NET_PortInformation ( )
virtualdefault

Member Function Documentation

bool NET_PortInformation::handle ( NET_HTTPWebTaskHandler handler)
bool NET_PortInformation::handleWebSocket ( NET_WebSocketHandler handler,
const UT_StringHolder msg 
)
void NET_PortInformation::insertHandler ( const NET_UrlHandlerPtr handler)
static bool NET_PortInformation::isOriginAccepted ( const UT_StringArray whitelist,
const UT_Url origin 
)
static
SYS_NO_DISCARD_RESULT bool NET_PortInformation::isValid ( ) const
inline

Definition at line 100 of file NET_WebServer.h.

SYS_NO_DISCARD_RESULT int NET_PortInformation::port ( ) const
inline

Definition at line 96 of file NET_WebServer.h.

void NET_PortInformation::routeRequest ( NET_HTTPRequest req,
NET_WebResponse resp 
) const
void NET_PortInformation::setPort ( int  port)
inline

Definition at line 92 of file NET_WebServer.h.

NET_WebSocketAPIRouter& NET_PortInformation::webSocketRouter ( )
inline

Definition at line 112 of file NET_WebServer.h.

Friends And Related Function Documentation

friend class NET_WebServer
friend

Definition at line 131 of file NET_WebServer.h.

Member Data Documentation

UT_StringArray NET_PortInformation::myOriginWhitelist

Definition at line 120 of file NET_WebServer.h.


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