RestLink::NetworkResponse Class Reference

#include <networkresponse.h>

Inherits RestLink::Response.

Public Slots
void	ignoreSslErrors () override
void	abort () override
Public Slots inherited from RestLink::Response
virtual void	ignoreSslErrors ()
virtual void	abort ()=0

Public Member Functions
	NetworkResponse (QObject *parent)
AbstractRequestHandler::Method	method () const override
QNetworkRequest	networkRequest () const override
	Retrieves the network request used in this response.
bool	isFinished () const override
	Checks if the request has finished processing.
int	httpStatusCode () const override
QString	httpReasonPhrase () const override
bool	hasHeader (const QByteArray &name) const override
	Checks if the response contains a specific header.
QByteArray	header (const QByteArray &name) const override
	Retrieves the value of a specific header.
QByteArrayList	headerList () const override
QByteArray	readBody () override
	Reads the raw response body as a QByteArray.
int	networkError () const override
	Retrieves the network error code.
QString	networkErrorString () const override
	Retrieves a string description of the network error.
QNetworkReply *	networkReply () const override
Public Member Functions inherited from RestLink::Response
virtual	~Response ()
	Destructor for Response.
QString	endpoint () const
	Retrieves the API endpoint associated with this response.
Request	request () const
	Retrieves the API request associated with this response.
Api *	api () const
	Retrieves the API instance associated with this response.
QUrl	url () const
	Retrieves the URL associated with this response.
bool	isRunning () const
	Checks if the request is currently running.
bool	isSuccess () const
	Checks if the request was successful.
bool	isHttpStatusSuccess () const
	Checks if the HTTP status code indicates success.
bool	hasHttpStatusCode () const
	Checks if the HTTP status code is valid.
bool	hasNetworkError () const
Public Member Functions inherited from RestLink::ResponseBase
	ResponseBase (QObject *parent=nullptr)
virtual	~ResponseBase ()
bool	isSequential () const override
bool	open (OpenMode mode) override
void	close () override
qint64	pos () const override
qint64	size () const override
bool	seek (qint64 pos) override
bool	atEnd () const override
bool	reset () override
qint64	bytesAvailable () const override
qint64	bytesToWrite () const override
bool	canReadLine () const override
bool	waitForReadyRead (int msecs) override
bool	waitForBytesWritten (int msecs) override
virtual QJsonObject	readJsonObject (QJsonParseError *error=nullptr)
	Reads the response body as a JSON object.
virtual QJsonArray	readJsonArray (QJsonParseError *error=nullptr)
	Reads the response body as a JSON array.
virtual QJsonValue	readJson (QJsonParseError *error=nullptr)
	Reads the response body as a JSON value.
virtual QString	readString ()
	Reads the response body as a QString.
QIODevice *	responseDevice () const

Additional Inherited Members
Signals inherited from RestLink::Response
void	downloadProgress (qint64 bytesReceived, qint64 bytesTotal)
void	uploadProgress (qint64 bytesSent, qint64 bytesTotal)
void	networkErrorOccured (int error)
void	finished ()
void	sslErrorsOccured (const QList< QSslError > &errors)
Protected Member Functions inherited from RestLink::Response
	Response (ResponsePrivate *d, QObject *parent)
void	setRequest (const Request &request)
QByteArray	body ()
Protected Member Functions inherited from RestLink::ResponseBase
qint64	readData (char *data, qint64 maxlen) override
qint64	readLineData (char *data, qint64 maxlen) override
qint64	skipData (qint64 maxSize) override
qint64	writeData (const char *data, qint64 len) override
void	setResponseDevice (QIODevice *device)
Protected Attributes inherited from RestLink::Response
QScopedPointer< ResponsePrivate >	d_ptr
Properties inherited from RestLink::Response
QString	endpoint
int	method
	Retrieves the HTTP method type for this response.
QUrl	url
bool	running
bool	finished
bool	success
bool	hasHttpStatusCode
int	httpStatusCode
	Retrieves the HTTP status code of the response.
QString	httpReasonPhrase
	Retrieves the HTTP reason phrase of the response.
QByteArrayList	headerList
	Retrieves a list of all headers in the response.
bool	hasNetworkError
	Checks if a network error occurred during the request.
int	networkError
QString	networkErrorString
QByteArray	body

Constructor & Destructor Documentation

NetworkResponse()

RestLink::NetworkResponse::NetworkResponse ( QObject *  parent )

explicit

Member Function Documentation

method()

AbstractRequestHandler::Method RestLink::NetworkResponse::method ( ) const

overridevirtual

Implements RestLink::Response.

networkRequest()

QNetworkRequest RestLink::NetworkResponse::networkRequest ( ) const

overridevirtual

Retrieves the network request used in this response.

Returns

The QNetworkRequest object.

Implements RestLink::Response.

isFinished()

bool RestLink::NetworkResponse::isFinished ( ) const

overridevirtual

Checks if the request has finished processing.

Returns

true if the request is finished, otherwise false.

Implements RestLink::Response.

httpStatusCode()

int RestLink::NetworkResponse::httpStatusCode ( ) const

overridevirtual

Implements RestLink::Response.

httpReasonPhrase()

QString RestLink::NetworkResponse::httpReasonPhrase ( ) const

overridevirtual

Reimplemented from RestLink::Response.

hasHeader()

bool RestLink::NetworkResponse::hasHeader ( const QByteArray &  name ) const

overridevirtual

Checks if the response contains a specific header.

Parameters

name	The name of the header to check.

Returns

true if the header is present, otherwise false.

Reimplemented from RestLink::Response.

header()

QByteArray RestLink::NetworkResponse::header ( const QByteArray &  name ) const

overridevirtual

Retrieves the value of a specific header.

Parameters

header

The name of the header to retrieve.

Returns

The header value as a QByteArray.

Implements RestLink::Response.

headerList()

QByteArrayList RestLink::NetworkResponse::headerList ( ) const

overridevirtual

Implements RestLink::Response.

readBody()

QByteArray RestLink::NetworkResponse::readBody ( )

overridevirtual

Reads the raw response body as a QByteArray.

Returns

The response body as a QByteArray.

Reimplemented from RestLink::ResponseBase.

networkError()

int RestLink::NetworkResponse::networkError ( ) const

overridevirtual

Retrieves the network error code.

Returns

The network error code.

Reimplemented from RestLink::Response.

networkErrorString()

QString RestLink::NetworkResponse::networkErrorString ( ) const

overridevirtual

Retrieves a string description of the network error.

Returns

The network error description as a QString.

Reimplemented from RestLink::Response.

networkReply()

QNetworkReply * RestLink::NetworkResponse::networkReply ( ) const

overridevirtual

Implements RestLink::Response.

ignoreSslErrors

void RestLink::NetworkResponse::ignoreSslErrors ( )

overrideslot

abort

void RestLink::NetworkResponse::abort ( )

overrideslot