1.26.2.1
Gameface
cohtml::IAsyncResourceRequest Class Referenceabstract

Encapsulates an asynchronous resource request. More...

Classes

struct  FallbackURLsData
 

Public Member Functions

 IAsyncResourceRequest ()
 
virtual ~IAsyncResourceRequest ()
 
virtual unsigned GetId () const =0
 The ID of the request. More...
 
virtual const char * GetURL () const =0
 The request URL. More...
 
virtual const char * GetAbsoluteURL () const =0
 Absolute URL taking into account the current URL of the View. More...
 
virtual const char * GetMethod () const =0
 Get the request method. More...
 
virtual const char * GetUsername () const =0
 Get the username (optional) More...
 
virtual const char * GetPassword () const =0
 Get the password (optional) More...
 
virtual const char * GetHeaderValue (const char *name) const =0
 Returns the value of a particular header if exists. More...
 
virtual unsigned GetHeadersCount () const =0
 Returns the count of all headers in the request. More...
 
virtual const char * GetHeaderName (unsigned id) const =0
 Returns the name of the header at id. More...
 
virtual const char * GetHeaderValue (unsigned id) const =0
 Returns the value of the header at id. More...
 
virtual const char * GetBody () const =0
 Returns pointer to the request body. More...
 
virtual unsigned GetBodySize () const =0
 Get the length of the request body. More...
 
virtual FallbackURLsData GetFallbackURLs () const =0
 

Detailed Description

Encapsulates an asynchronous resource request.

Constructor & Destructor Documentation

◆ IAsyncResourceRequest()

cohtml::IAsyncResourceRequest::IAsyncResourceRequest ( )

◆ ~IAsyncResourceRequest()

virtual cohtml::IAsyncResourceRequest::~IAsyncResourceRequest ( )
virtual

Member Function Documentation

◆ GetAbsoluteURL()

virtual const char* cohtml::IAsyncResourceRequest::GetAbsoluteURL ( ) const
pure virtual

Absolute URL taking into account the current URL of the View.

◆ GetBody()

virtual const char* cohtml::IAsyncResourceRequest::GetBody ( ) const
pure virtual

Returns pointer to the request body.

◆ GetBodySize()

virtual unsigned cohtml::IAsyncResourceRequest::GetBodySize ( ) const
pure virtual

Get the length of the request body.

◆ GetFallbackURLs()

virtual FallbackURLsData cohtml::IAsyncResourceRequest::GetFallbackURLs ( ) const
pure virtual

◆ GetHeaderName()

virtual const char* cohtml::IAsyncResourceRequest::GetHeaderName ( unsigned  id) const
pure virtual

Returns the name of the header at id.

◆ GetHeadersCount()

virtual unsigned cohtml::IAsyncResourceRequest::GetHeadersCount ( ) const
pure virtual

Returns the count of all headers in the request.

◆ GetHeaderValue() [1/2]

virtual const char* cohtml::IAsyncResourceRequest::GetHeaderValue ( const char *  name) const
pure virtual

Returns the value of a particular header if exists.

◆ GetHeaderValue() [2/2]

virtual const char* cohtml::IAsyncResourceRequest::GetHeaderValue ( unsigned  id) const
pure virtual

Returns the value of the header at id.

◆ GetId()

virtual unsigned cohtml::IAsyncResourceRequest::GetId ( ) const
pure virtual

The ID of the request.

◆ GetMethod()

virtual const char* cohtml::IAsyncResourceRequest::GetMethod ( ) const
pure virtual

Get the request method.

◆ GetPassword()

virtual const char* cohtml::IAsyncResourceRequest::GetPassword ( ) const
pure virtual

Get the password (optional)

◆ GetURL()

virtual const char* cohtml::IAsyncResourceRequest::GetURL ( ) const
pure virtual

The request URL.

◆ GetUsername()

virtual const char* cohtml::IAsyncResourceRequest::GetUsername ( ) const
pure virtual

Get the username (optional)