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

Response object used for responding to request in the server. More...

#include <NET_WebResponse.h>

+ Inheritance diagram for NET_WebResponse:

Public Member Functions

 NET_WebResponse ()
 
 NET_WebResponse (NET_HTTPStatusCode code)
 
 NET_WebResponse (NET_HTTPStatusCode code, const UT_StringHolder &data)
 
 NET_WebResponse (NET_HTTPStatusCode code, const HeaderMap &headers, const UT_StringHolder &data)
 
 NET_WebResponse (NET_HTTPStatusCode code, const HeaderMap &headers)
 
 NET_WebResponse (const NET_WebResponse &resp)
 
NET_WebResponseoperator= (const NET_WebResponse &resp)
 
 NET_WebResponse (NET_WebResponse &&resp)
 
NET_WebResponseoperator= (NET_WebResponse &&resp)
 
 NET_WebResponse (const NET_HTTPResponse &resp)
 
NET_WebResponseoperator= (const NET_HTTPResponse &resp)
 
void clear ()
 
bool isFile () const
 
bool isChunked () const
 
- Public Member Functions inherited from NET_BaseWebResponse
 NET_BaseWebResponse ()
 
 NET_BaseWebResponse (NET_HTTPStatusCode code)
 
 NET_BaseWebResponse (NET_HTTPStatusCode code, const UT_StringHolder &data)
 
 NET_BaseWebResponse (NET_HTTPStatusCode code, const HeaderMap &headers, const UT_StringHolder &data)
 
 NET_BaseWebResponse (NET_HTTPStatusCode code, const HeaderMap &headers)
 
 operator bool () const
 
bool isSuccess () const
 
bool isRequestNotFound () const
 
bool isBadRequest () const
 
bool hasTimedout () const
 
UT_StringHolder headersAsString () const
 
bool hasHeader (const UT_StringRef &header) const
 
UT_Optional< const
UT_StringHolder & > 
getHeaderContentType ()
 
UT_Optional< exintgetHeaderContentLength ()
 
bool hasContentType (const UT_StringRef &mime) const
 
NET_Time modTime () const
 
bool hasJSONBody () const
 

Public Attributes

NET_RequestRangeList myRanges
 
UT_StringHolder myFile
 
bool myDeleteFile
 
UT_StringHolder myErrors
 
- Public Attributes inherited from NET_BaseWebResponse
NET_HTTPStatusCode myStatus
 
HeaderMap myHeaders
 
UT_StringArray myCookies
 
UT_StringHolder myData
 

Additional Inherited Members

- Public Types inherited from NET_BaseWebResponse
using HeaderMap = UT_ArrayStringMap< UT_StringHolder >
 
- Static Public Member Functions inherited from NET_BaseWebResponse
static void stockMsgFromCode (NET_HTTPStatusCode code, UT_WorkBuffer &msg)
 
static bool isJSONBody (const HeaderMap &headers)
 

Detailed Description

Response object used for responding to request in the server.

Definition at line 274 of file NET_WebResponse.h.

Constructor & Destructor Documentation

NET_WebResponse::NET_WebResponse ( )
inline

Definition at line 277 of file NET_WebResponse.h.

NET_WebResponse::NET_WebResponse ( NET_HTTPStatusCode  code)
inline

Definition at line 281 of file NET_WebResponse.h.

NET_WebResponse::NET_WebResponse ( NET_HTTPStatusCode  code,
const UT_StringHolder data 
)
inline

Definition at line 285 of file NET_WebResponse.h.

NET_WebResponse::NET_WebResponse ( NET_HTTPStatusCode  code,
const HeaderMap headers,
const UT_StringHolder data 
)
inline

Definition at line 292 of file NET_WebResponse.h.

NET_WebResponse::NET_WebResponse ( NET_HTTPStatusCode  code,
const HeaderMap headers 
)
inline

Definition at line 302 of file NET_WebResponse.h.

NET_WebResponse::NET_WebResponse ( const NET_WebResponse resp)
inline

Definition at line 310 of file NET_WebResponse.h.

NET_WebResponse::NET_WebResponse ( NET_WebResponse &&  resp)
inline

Definition at line 327 of file NET_WebResponse.h.

NET_WebResponse::NET_WebResponse ( const NET_HTTPResponse resp)
inline

Definition at line 346 of file NET_WebResponse.h.

Member Function Documentation

void NET_WebResponse::clear ( )
bool NET_WebResponse::isChunked ( ) const
inline

Definition at line 364 of file NET_WebResponse.h.

bool NET_WebResponse::isFile ( ) const
inline

Definition at line 362 of file NET_WebResponse.h.

NET_WebResponse& NET_WebResponse::operator= ( const NET_WebResponse resp)
inline

Definition at line 318 of file NET_WebResponse.h.

NET_WebResponse& NET_WebResponse::operator= ( NET_WebResponse &&  resp)
inline

Definition at line 335 of file NET_WebResponse.h.

NET_WebResponse& NET_WebResponse::operator= ( const NET_HTTPResponse resp)
inline

Definition at line 350 of file NET_WebResponse.h.

Member Data Documentation

bool NET_WebResponse::myDeleteFile

Definition at line 374 of file NET_WebResponse.h.

UT_StringHolder NET_WebResponse::myErrors

Definition at line 376 of file NET_WebResponse.h.

UT_StringHolder NET_WebResponse::myFile

Definition at line 373 of file NET_WebResponse.h.

NET_RequestRangeList NET_WebResponse::myRanges

Definition at line 372 of file NET_WebResponse.h.


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