Cutelyst  1.11.0
Public Member Functions | List of all members
Cutelyst::Headers Class Reference

Public Member Functions

 Headers ()
 
 Headers (std::initializer_list< std::pair< QString, QString > > list)
 
QString authorization () const
 
QString authorizationBasic () const
 
QPair< QString, QString > authorizationBasicPair () const
 
QHash< QString, QString > authorizationDigest () const
 
void clear ()
 
QString connection () const
 
bool contains (const QString &field)
 
QString contentDisposition () const
 
QString contentEncoding () const
 
bool contentIsHtml () const
 
bool contentIsText () const
 
bool contentIsXHtml () const
 
bool contentIsXml () const
 
qint64 contentLength () const
 
QString contentType () const
 
QString contentTypeCharset () const
 
QHash< QString, QString > data () const
 
QDateTime date () const
 
QString header (const QString &field) const
 
QString header (const QString &field, const QString &defaultValue) const
 
QString host () const
 
QString ifModifiedSince () const
 
QDateTime ifModifiedSinceDateTime () const
 
QString lastModified () const
 
 operator QVariant () const
 
bool operator!= (const Headers &other) const
 
Headersoperator= (const Headers &other)
 
bool operator== (const Headers &other) const
 
QString & operator[] (const QString &key)
 
const QString operator[] (const QString &key) const
 
QString proxyAuthorization () const
 
QString proxyAuthorizationBasic () const
 
QPair< QString, QString > proxyAuthorizationBasicPair () const
 
void pushHeader (const QString &field, const QString &value)
 
void pushHeader (const QString &field, const QStringList &values)
 
void pushRawHeader (const QString &field, const QString &value)
 
QString referer () const
 
void removeHeader (const QString &field)
 
QString server () const
 
QString setAuthorizationBasic (const QString &username, const QString &password)
 
void setContentDisposition (const QString &contentDisposition)
 
void setContentDispositionAttachment (const QString &filename=QString())
 
void setContentEncoding (const QString &encoding)
 
void setContentLength (qint64 value)
 
void setContentType (const QString &contentType)
 
void setContentTypeCharset (const QString &charset)
 
QString setDateWithDateTime (const QDateTime &date)
 
void setHeader (const QString &field, const QString &value)
 
void setHeader (const QString &field, const QStringList &values)
 
void setLastModified (const QString &value)
 
QString setLastModified (const QDateTime &lastModified)
 
void setProxyAuthenticate (const QString &value)
 
void setReferer (const QString &value)
 
void setServer (const QString &value)
 
void setWwwAuthenticate (const QString &value)
 
QString userAgent () const
 

Detailed Description

Definition at line 29 of file headers.h.

Constructor & Destructor Documentation

Headers::Headers ( )

Construct an empty header object.

Definition at line 30 of file headers.cpp.

Cutelyst::Headers::Headers ( std::initializer_list< std::pair< QString, QString > >  list)
inline

Construct a header from a std::initializer_list given by list.

Definition at line 41 of file headers.h.

Member Function Documentation

QString Headers::authorization ( ) const

This method is used to get an authorization header without any decoding.

Definition at line 297 of file headers.cpp.

Referenced by authorizationBasic(), authorizationBasicPair(), and operator[]().

QString Headers::authorizationBasic ( ) const

This method is used to get an authorization header that use the "Basic Authentication Scheme". It will return "username:password" as a single string value.

Definition at line 302 of file headers.cpp.

References authorization().

QPair< QString, QString > Headers::authorizationBasicPair ( ) const

This method is used to get an authorization header that use the "Basic Authentication Scheme". It will return a pair of username and password respectively.

Definition at line 307 of file headers.cpp.

References authorization().

QHash< QString, QString > Headers::authorizationDigest ( ) const

This method is used to get all the fields that build a "Digest Authentication Scheme". It will return a Hash containing keys and values.

Definition at line 326 of file headers.cpp.

void Cutelyst::Headers::clear ( )
inline

Clears all headers.

Definition at line 331 of file headers.h.

QString Headers::connection ( ) const

Returns the 'Connection' header field that indicates how it should be handled after a request has been processed, like 'close'.

Definition at line 256 of file headers.cpp.

bool Headers::contains ( const QString &  field)

Returns true if the header field is defined.

Definition at line 383 of file headers.cpp.

QString Headers::contentDisposition ( ) const

The Content-Disposition header field indicates if the content is expected to be displayed inline in the browser, that is, as a Web page or as part of a Web page, or as an attachment, that is downloaded and saved locally

Definition at line 35 of file headers.cpp.

QString Headers::contentEncoding ( ) const

The Content-Encoding header field is used as a modifier to the media type. When present, its value indicates what additional encoding mechanism has been applied to the resource.

Definition at line 54 of file headers.cpp.

bool Headers::contentIsHtml ( ) const

Returns TRUE if the Content-Type header field indicate that the content is some kind of HTML (including XHTML).

Definition at line 134 of file headers.cpp.

References contentType().

bool Headers::contentIsText ( ) const

Returns TRUE if the Content-Type header field indicate that the content is textual.

Definition at line 129 of file headers.cpp.

bool Headers::contentIsXHtml ( ) const

Returns TRUE if the Content-Type header field indicate that the content is XHTML.

Definition at line 142 of file headers.cpp.

References contentType().

bool Headers::contentIsXml ( ) const

Returns TRUE if the Content-Type header field indicate that the content is XML.

Definition at line 149 of file headers.cpp.

References contentType().

qint64 Headers::contentLength ( ) const

Returns the size in bytes of the message content

Definition at line 157 of file headers.cpp.

Referenced by Cutelyst::EngineRequest::finalizeHeaders().

QString Headers::contentType ( ) const

The Content-Type header field indicates the media type of the message content. E.g.: "text/html" The value returned will be converted to lower case, and potential parameters will be ignored. If there is no such header field, then the empty string is returned.

Definition at line 64 of file headers.cpp.

Referenced by contentIsHtml(), contentIsXHtml(), contentIsXml(), contentTypeCharset(), and setContentTypeCharset().

QString Headers::contentTypeCharset ( ) const

Returns the upper-cased charset specified in the Content-Type header.

Definition at line 80 of file headers.cpp.

References contentType().

QHash<QString, QString> Cutelyst::Headers::data ( ) const
inline

Returns the internal structure of headers, to be used by Engine subclasses.

Definition at line 338 of file headers.h.

QDateTime Headers::date ( ) const

Returns the date header as QDateTime

Definition at line 181 of file headers.cpp.

QString Headers::header ( const QString &  field) const

Returns the value associated with field

Definition at line 348 of file headers.cpp.

Referenced by ifModifiedSince().

QString Headers::header ( const QString &  field,
const QString &  defaultValue 
) const

Returns the value associated with field, if field is not set defaultValue is returned

Definition at line 353 of file headers.cpp.

QString Headers::host ( ) const

Returns the 'Host' header field used in request messages, containing information about which host the client would like to talk to, this is especially useful for building URIs and for VirtualHosts.

Definition at line 261 of file headers.cpp.

QString Headers::ifModifiedSince ( ) const

This header fields is used to make a request conditional. If the requested resource has (or has not) been modified since the time specified in this field, then the server will return a 304 Not Modified response instead of the document itself.

Definition at line 201 of file headers.cpp.

References header().

QDateTime Headers::ifModifiedSinceDateTime ( ) const

This header fields is used to make a request conditional. If the requested resource has (or has not) been modified since the time specified in this field, then the server will return a 304 Not Modified response instead of the document itself. This method parses the header and convert to QDateTime assuming the date is in GMT timezone.

Definition at line 206 of file headers.cpp.

QString Headers::lastModified ( ) const

This header indicates the date and time at which the resource was last modified.

Definition at line 226 of file headers.cpp.

Cutelyst::Headers::operator QVariant ( ) const
inline

Returns this Header internal data as a QVariant for easiness with Q_PROPERTY.

Definition at line 383 of file headers.h.

bool Cutelyst::Headers::operator!= ( const Headers other) const
inline

Compares if another Header object does not have the same data as this.

Definition at line 376 of file headers.h.

Headers& Cutelyst::Headers::operator= ( const Headers other)
inline

Assigns other to this Header and returns a reference to this Header.

Definition at line 360 of file headers.h.

bool Cutelyst::Headers::operator== ( const Headers other) const
inline

Compares if another Header object has the same data as this.

Definition at line 369 of file headers.h.

QString & Headers::operator[] ( const QString &  key)

Returns the value reference associated with key.

Definition at line 388 of file headers.cpp.

const QString Headers::operator[] ( const QString &  key) const

Returns the const value associated with key.

Definition at line 393 of file headers.cpp.

References authorization().

QString Headers::proxyAuthorization ( ) const

A user agent that wishes to authenticate itself with a server or a proxy, may do so by including these headers.

Definition at line 333 of file headers.cpp.

Referenced by proxyAuthorizationBasic(), and proxyAuthorizationBasicPair().

QString Headers::proxyAuthorizationBasic ( ) const

This method is used to get an authorization header that use the "Basic Authentication Scheme" but using the "Proxy-Authorization" header instead. It will return "username:password" as a single string value.

Definition at line 338 of file headers.cpp.

References proxyAuthorization().

QPair< QString, QString > Headers::proxyAuthorizationBasicPair ( ) const

This method is used to get an authorization header that use the "Basic Authentication Scheme" but using the "Proxy-Authorization" header instead. It will return a pair of username and password respectively.

Definition at line 343 of file headers.cpp.

References proxyAuthorization().

void Headers::pushHeader ( const QString &  field,
const QString &  value 
)

Appends the header field to values

Definition at line 368 of file headers.cpp.

Referenced by Cutelyst::EngineRequest::finalizeCookies(), Cutelyst::Engine::finalizeCookies(), and Cutelyst::StaticCompressed::setup().

void Headers::pushHeader ( const QString &  field,
const QStringList &  values 
)

This method appends a header to internal data normalizing the key.

Definition at line 373 of file headers.cpp.

void Cutelyst::Headers::pushRawHeader ( const QString &  field,
const QString &  value 
)
inline

This method directly inserts a Header in it's properly form which is field in upper case form with underscores instead of dashes, so 'Content-Type' becomes 'CONTENT_TYPE' like CGI does, this method should be used only by Engines to get faster performance and avoiding normalization.

Definition at line 391 of file headers.h.

QString Headers::referer ( ) const

Used to specify the address (URI) of the document from which the requested resource address was obtained.

Definition at line 271 of file headers.cpp.

void Headers::removeHeader ( const QString &  field)

This method removes a header identified by field.

Definition at line 378 of file headers.cpp.

QString Headers::server ( ) const

Returns the server header field contains information about the software being used by the originating server program handling the request.

Definition at line 246 of file headers.cpp.

QString Headers::setAuthorizationBasic ( const QString &  username,
const QString &  password 
)

This method is used to set an authorization header that use the "Basic Authentication Scheme". It won't set the values if username contains a colon ':'.

Definition at line 312 of file headers.cpp.

void Headers::setContentDisposition ( const QString &  contentDisposition)

Defines the Content-Disposition header

See also
contentDisposition()

Definition at line 40 of file headers.cpp.

Referenced by setContentDispositionAttachment().

void Headers::setContentDispositionAttachment ( const QString &  filename = QString())

Defines the Content-Disposition header as type attachment and the optional filename parameter

See also
contentDisposition()

Definition at line 45 of file headers.cpp.

References setContentDisposition().

void Headers::setContentEncoding ( const QString &  encoding)

Defines the Content-Encoding header

See also
contentEncoding()

Definition at line 59 of file headers.cpp.

Referenced by Cutelyst::StaticCompressed::setup().

void Headers::setContentLength ( qint64  value)

Defines the size in bytes of the message content

Definition at line 166 of file headers.cpp.

Referenced by Cutelyst::EngineRequest::finalizeHeaders(), Cutelyst::StaticSimple::setup(), Cutelyst::StaticCompressed::setup(), and Cutelyst::Response::webSocketClose().

void Headers::setContentType ( const QString &  contentType)

Defines the Content-Encoding header

See also
contentType()

Definition at line 75 of file headers.cpp.

Referenced by Cutelyst::StaticSimple::setup(), and Cutelyst::StaticCompressed::setup().

void Headers::setContentTypeCharset ( const QString &  charset)

The Content-Type header field indicates the media type of the message content. this defines the charset of the content-type

Definition at line 96 of file headers.cpp.

References contentType().

QString Headers::setDateWithDateTime ( const QDateTime &  date)

Defines the header that represents the date and time at which the message was originated

Definition at line 171 of file headers.cpp.

void Headers::setHeader ( const QString &  field,
const QString &  value 
)
void Headers::setHeader ( const QString &  field,
const QStringList &  values 
)

Sets the header field to the list of values

Definition at line 363 of file headers.cpp.

References setHeader().

void Headers::setLastModified ( const QString &  value)

Defines the date and time at which the resource was last modified.

Definition at line 231 of file headers.cpp.

Referenced by setLastModified(), Cutelyst::StaticSimple::setup(), and Cutelyst::StaticCompressed::setup().

QString Headers::setLastModified ( const QDateTime &  lastModified)

Defines the date and time at which the resource was last modified. This method takes a QDateTime and write it in RFC 822 and GMT timezone.

Definition at line 236 of file headers.cpp.

References setLastModified().

void Headers::setProxyAuthenticate ( const QString &  value)

This header must be included in a 407 Proxy Authentication Required response.

Definition at line 292 of file headers.cpp.

void Headers::setReferer ( const QString &  value)

Sets the referrer (Referer) header. This method removes the fragment from the given URI if it is present, as mandated by RFC2616. Note that the removal does not happen automatically if using the setHeader() method to set the referrer

Definition at line 276 of file headers.cpp.

void Headers::setServer ( const QString &  value)

Defines the server header field contains information about the software being used by the originating server program handling the request.

Definition at line 251 of file headers.cpp.

void Headers::setWwwAuthenticate ( const QString &  value)

This header must be included as part of a 401 Unauthorized response. The field value consist of a challenge that indicates the authentication scheme and parameters applicable to the requested URI.

Definition at line 287 of file headers.cpp.

Referenced by Cutelyst::CredentialHttp::authenticate().

QString Headers::userAgent ( ) const

Returns the header field used in request messages, containing information about the user agent originating the request.

Definition at line 266 of file headers.cpp.