QtMockWebServer  1.0
 All Classes Functions Pages
Public Member Functions | List of all members
QtMockWebServer Class Reference

A mock web server serving requests using pre-queued mock responses by default. More...

#include <QtMockWebServer.h>

Inheritance diagram for QtMockWebServer:

Public Member Functions

int port () const
 Port of the mock server listening. Note that it's only avaliable after server started by play(). More...
 
QString hostName () const
 host name of the mock server listening. Note that it's only available after server started by play(). More...
 
QUrl getUrl (const QString &path)
 Get absolute url of given path. Note that it's only available after server started by play(). More...
 
void setBodyLimit (int maxBodyLength)
 Set max length limit of response body. More...
 
RecordedRequest takeRequest ()
 Take next recorded request the server received. More...
 
int requestCount () const
 Count of requests the server received. More...
 
void enqueue (const MockResponse &response)
 Enqueue a mock response to be served. More...
 
void play ()
 Start the server.
 
void play (int port)
 Try to start the server on given port. More...
 
void shutdown ()
 Shut down the server.
 
void setDispatcher (Dispatcher *dispatcher)
 Set a custom dispatcher which decides how to serve requests. More...
 

Detailed Description

A mock web server serving requests using pre-queued mock responses by default.

Member Function Documentation

void QtMockWebServer::enqueue ( const MockResponse response)

Enqueue a mock response to be served.

Parameters
responseThe mock response.
QUrl QtMockWebServer::getUrl ( const QString &  path)

Get absolute url of given path. Note that it's only available after server started by play().

Parameters
pathRequested path.
Returns
Absolute url of given path.
QString QtMockWebServer::hostName ( ) const

host name of the mock server listening. Note that it's only available after server started by play().

Returns
Server host name.
void QtMockWebServer::play ( int  port)

Try to start the server on given port.

Parameters
portStart the server on this port.
int QtMockWebServer::port ( ) const

Port of the mock server listening. Note that it's only avaliable after server started by play().

Returns
Server port number
int QtMockWebServer::requestCount ( ) const

Count of requests the server received.

Returns
Count of requests.
void QtMockWebServer::setBodyLimit ( int  maxBodyLength)

Set max length limit of response body.

Todo:
Not fully implemented.
Parameters
maxBodyLengthMax body length limit.
void QtMockWebServer::setDispatcher ( Dispatcher dispatcher)

Set a custom dispatcher which decides how to serve requests.

Parameters
dispatcherThe custome dispatcher.
RecordedRequest QtMockWebServer::takeRequest ( )

Take next recorded request the server received.

Returns
Next recorded request.

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