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

#include <NET_WebEndpoint.h>

Public Types

enum  State { kNORMAL, kDEATH }
 
using Id = int32
 

Public Member Functions

 NET_WebEndpoint ()
 
 NET_WebEndpoint (bool is_secure, NET_WebStreamPtr stream, bool has_read_access, bool has_write_access, unsigned short client_ip[4])
 
 ~NET_WebEndpoint ()
 
 NET_WebEndpoint (const NET_WebEndpoint &)=delete
 
NET_WebEndpointoperator= (const NET_WebEndpoint &)=delete
 
 NET_WebEndpoint (NET_WebEndpoint &&)=delete
 
NET_WebEndpointoperator= (NET_WebEndpoint &&)=delete
 
bool operator== (const NET_WebEndpoint &other) const
 
bool operator!= (const NET_WebEndpoint &other) const
 
bool initialize (UT_UniquePtr< UT_NetSocket > socket, int port)
 
void getClientIp (unsigned short ip[4]) const
 
UT_StringHolder clientIpStr () const
 
int port () const
 
bool hasValidStream () const
 
void debugPrint () const
 
int getFD () const
 
Id getId () const
 
SYS_FORCE_INLINE bool isAlive () const
 
SYS_FORCE_INLINE void setIsAlive (bool is_alive)
 
SYS_FORCE_INLINE bool isProcessing () const
 
SYS_FORCE_INLINE void markProcessing ()
 
SYS_FORCE_INLINE void markFinishedProcessing ()
 
void startProcessQueue ()
 We are about to placed on the queue for processing. More...
 
void setNewHandler (UT_UniquePtr< NET_WebTaskHandler > handler)
 
void process ()
 
unsigned taskCount () const
 
int64 calcElapsedTime (time_t now) const
 
const char * handlerClassName ()
 

Public Attributes

NET_WebStreamPtr myStream
 
bool myIsSecure
 
bool myHasReadAccess
 
bool myHasWriteAccess
 
unsigned short myClientIp [4]
 
State myState
 

Detailed Description

Definition at line 32 of file NET_WebEndpoint.h.

Member Typedef Documentation

Definition at line 40 of file NET_WebEndpoint.h.

Member Enumeration Documentation

Enumerator
kNORMAL 
kDEATH 

Definition at line 35 of file NET_WebEndpoint.h.

Constructor & Destructor Documentation

NET_WebEndpoint::NET_WebEndpoint ( )
NET_WebEndpoint::NET_WebEndpoint ( bool  is_secure,
NET_WebStreamPtr  stream,
bool  has_read_access,
bool  has_write_access,
unsigned short  client_ip[4] 
)
NET_WebEndpoint::~NET_WebEndpoint ( )
NET_WebEndpoint::NET_WebEndpoint ( const NET_WebEndpoint )
delete
NET_WebEndpoint::NET_WebEndpoint ( NET_WebEndpoint &&  )
delete

Member Function Documentation

int64 NET_WebEndpoint::calcElapsedTime ( time_t  now) const
UT_StringHolder NET_WebEndpoint::clientIpStr ( ) const
void NET_WebEndpoint::debugPrint ( ) const
void NET_WebEndpoint::getClientIp ( unsigned short  ip[4]) const
int NET_WebEndpoint::getFD ( ) const
inline

Definition at line 83 of file NET_WebEndpoint.h.

Id NET_WebEndpoint::getId ( ) const
inline

Definition at line 90 of file NET_WebEndpoint.h.

const char* NET_WebEndpoint::handlerClassName ( )
bool NET_WebEndpoint::hasValidStream ( ) const
inline

Definition at line 79 of file NET_WebEndpoint.h.

bool NET_WebEndpoint::initialize ( UT_UniquePtr< UT_NetSocket socket,
int  port 
)
SYS_FORCE_INLINE bool NET_WebEndpoint::isAlive ( ) const
inline

Definition at line 92 of file NET_WebEndpoint.h.

SYS_FORCE_INLINE bool NET_WebEndpoint::isProcessing ( ) const
inline

Definition at line 100 of file NET_WebEndpoint.h.

SYS_FORCE_INLINE void NET_WebEndpoint::markFinishedProcessing ( )
inline

Definition at line 108 of file NET_WebEndpoint.h.

SYS_FORCE_INLINE void NET_WebEndpoint::markProcessing ( )
inline

Definition at line 104 of file NET_WebEndpoint.h.

bool NET_WebEndpoint::operator!= ( const NET_WebEndpoint other) const
inline

Definition at line 60 of file NET_WebEndpoint.h.

NET_WebEndpoint& NET_WebEndpoint::operator= ( const NET_WebEndpoint )
delete
NET_WebEndpoint& NET_WebEndpoint::operator= ( NET_WebEndpoint &&  )
delete
bool NET_WebEndpoint::operator== ( const NET_WebEndpoint other) const
inline

Definition at line 56 of file NET_WebEndpoint.h.

int NET_WebEndpoint::port ( ) const
inline

Definition at line 71 of file NET_WebEndpoint.h.

void NET_WebEndpoint::process ( )
SYS_FORCE_INLINE void NET_WebEndpoint::setIsAlive ( bool  is_alive)
inline

Definition at line 96 of file NET_WebEndpoint.h.

void NET_WebEndpoint::setNewHandler ( UT_UniquePtr< NET_WebTaskHandler handler)
void NET_WebEndpoint::startProcessQueue ( )
inline

We are about to placed on the queue for processing.

Definition at line 114 of file NET_WebEndpoint.h.

unsigned NET_WebEndpoint::taskCount ( ) const
inline

Definition at line 127 of file NET_WebEndpoint.h.

Member Data Documentation

unsigned short NET_WebEndpoint::myClientIp[4]

Definition at line 121 of file NET_WebEndpoint.h.

bool NET_WebEndpoint::myHasReadAccess

Definition at line 118 of file NET_WebEndpoint.h.

bool NET_WebEndpoint::myHasWriteAccess

Definition at line 119 of file NET_WebEndpoint.h.

bool NET_WebEndpoint::myIsSecure

Definition at line 117 of file NET_WebEndpoint.h.

State NET_WebEndpoint::myState

Definition at line 122 of file NET_WebEndpoint.h.

NET_WebStreamPtr NET_WebEndpoint::myStream

Definition at line 116 of file NET_WebEndpoint.h.


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