#include <HttpClientConnection.h>

Inheritance diagram for HttpClientConnection:
[legend]
Collaboration diagram for HttpClientConnection:
[legend]

Public Member Functions

 HttpClientConnection ()
 
 ~HttpClientConnection ()
 
bool connect (const String &host, int port, bool useSsl=false) override
 
bool send (HttpRequest *request) override
 
HttpRequestgetRequest () override
 Returns pointer to the current request. More...
 
void reset () override
 
bool isFinished ()
 
- Public Member Functions inherited from HttpConnection
 HttpConnection (http_parser_type type, bool autoDestruct=false)
 
 HttpConnection (tcp_pcb *connection, http_parser_type type)
 
virtual void setDefaultParser ()
 
bool isActive ()
 
HttpResponsegetResponse ()
 Returns pointer to the current response. More...
 
int getResponseCode () const
 
String getResponseHeader (const String &headerName, const String &defaultValue=nullptr) const
 
HttpHeadersgetResponseHeaders ()
 
DateTime getLastModifiedDate () const
 
DateTime getServerDate () const
 
String getResponseString ()
 
- Public Member Functions inherited from TcpClient
 TcpClient (bool autoDestruct)
 
 TcpClient (tcp_pcb *clientTcp, TcpClientDataDelegate clientReceive, TcpClientCompleteDelegate onCompleted)
 
 TcpClient (TcpClientCompleteDelegate onCompleted, TcpClientEventDelegate onReadyToSend, TcpClientDataDelegate onReceive=nullptr)
 
 TcpClient (TcpClientCompleteDelegate onCompleted, TcpClientDataDelegate onReceive=nullptr)
 
 TcpClient (TcpClientDataDelegate onReceive)
 
 ~TcpClient ()
 
bool connect (const String &server, int port, bool useSsl=false) override
 
bool connect (IpAddress addr, uint16_t port, bool useSsl=false) override
 
void close () override
 
void setReceiveDelegate (TcpClientDataDelegate receiveCb=nullptr)
 Set or clear the callback for received data. More...
 
void setCompleteDelegate (TcpClientCompleteDelegate completeCb=nullptr)
 Set or clear the callback for connection close. More...
 
bool send (const char *data, uint16_t len, bool forceCloseAfterSent=false)
 
bool sendString (const String &data, bool forceCloseAfterSent=false)
 
bool isProcessing ()
 
TcpClientState getConnectionState ()
 
void setCloseAfterSent (bool ignoreIncomingData=false)
 
void commit ()
 Tries to send the pending data immediately. More...
 
- Public Member Functions inherited from TcpConnection
 TcpConnection (bool autoDestruct)
 
 TcpConnection (tcp_pcb *connection, bool autoDestruct)
 
virtual ~TcpConnection ()
 
int writeString (const char *data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Writes string data directly to the TCP buffer. More...
 
int writeString (const String &data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Writes string data directly to the TCP buffer. More...
 
virtual int write (const char *data, int len, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Base write operation. More...
 
int write (IDataSourceStream *stream)
 Writes stream data directly to the TCP buffer. More...
 
uint16_t getAvailableWriteSize ()
 
void flush ()
 
void setTimeOut (uint16_t waitTimeOut)
 
IpAddress getRemoteIp () const
 
uint16_t getRemotePort () const
 
void setDestroyedDelegate (TcpConnectionDestroyedDelegate destroyedDelegate)
 Sets a callback to be called when the object instance is destroyed. More...
 
void setSslInitHandler (Ssl::Session::InitDelegate handler)
 Set the SSL session initialisation callback. More...
 
bool setSslConnection (Ssl::Connection *connection)
 
Ssl::SessiongetSsl ()
 Get a pointer to the current SSL session object. More...
 
- Public Member Functions inherited from IpConnection
bool joinMulticastGroup (IpAddress localIp, IpAddress multicastIp)
 Uses IGMP to add a local network interface to multicast group. More...
 
bool joinMulticastGroup (IpAddress multicastIp)
 Uses IGMP to add all local network interfaces to multicast group. More...
 
bool leaveMulticastGroup (IpAddress localIp, IpAddress multicastIp)
 Uses IGMP to remove a local network interface from multicast group. More...
 
bool leaveMulticastGroup (IpAddress multicastIp)
 Uses IGMP to remove all local network interfaces from multicast group. More...
 

Protected Member Functions

int onMessageBegin (http_parser *parser) override
 Called when a new incoming data is beginning to come. More...
 
int onHeadersComplete (const HttpHeaders &headers) override
 Called when all headers are received. More...
 
int onBody (const char *at, size_t length) override
 Called when a piece of body data is received. More...
 
int onMessageComplete (http_parser *parser) override
 Called when the incoming data is complete. More...
 
void onReadyToSendData (TcpConnectionEvent sourceEvent) override
 
void onClosed () override
 Gets called when there is/was a tcp connection, the latter does not have to be established, that is closed due to error or normal disconnect. More...
 
void cleanup () override
 
void sslInitSession (Ssl::Session &session) override
 Override in inherited classes to perform custom session initialisation. More...
 
err_t onConnected (err_t err) override
 
- Protected Member Functions inherited from HttpConnection
void resetHeaders ()
 Called after all headers have been received and processed. More...
 
virtual void init (http_parser_type type)
 Initializes the http parser for a specific type of HTTP message. More...
 
virtual int onPath (const Url &uri)
 Called when the URL path is known. More...
 
virtual int onStatus (http_parser *parser)
 
virtual int onChunkHeader (http_parser *parser)
 
virtual int onChunkComplete (http_parser *parser)
 
virtual bool onProtocolUpgrade (http_parser *parser)
 Called when the HTTP protocol should be upgraded. More...
 
virtual bool onHttpError (HttpError error)
 Called when there was an error. More...
 
virtual bool onTcpReceive (TcpClient &client, char *data, int size)
 
void onError (err_t err) override
 
- Protected Member Functions inherited from TcpClient
err_t onConnected (err_t err) override
 
err_t onReceive (pbuf *buf) override
 
err_t onSent (uint16_t len) override
 
void onError (err_t err) override
 
void onClosed () override
 Gets called when there is/was a tcp connection, the latter does not have to be established, that is closed due to error or normal disconnect. More...
 
void onReadyToSendData (TcpConnectionEvent sourceEvent) override
 
virtual void onFinished (TcpClientState finishState)
 
void pushAsyncPart ()
 
void freeStreams ()
 
void setBuffer (ReadWriteStream *stream)
 
- Protected Member Functions inherited from TcpConnection
void initialize (tcp_pcb *pcb)
 
bool internalConnect (IpAddress addr, uint16_t port)
 
bool sslCreateSession ()
 
virtual err_t onPoll ()
 
void trySend (TcpConnectionEvent event)
 
err_t internalOnConnected (err_t err)
 
err_t internalOnReceive (pbuf *p, err_t err)
 
err_t internalOnSent (uint16_t len)
 
err_t internalOnPoll ()
 
void internalOnError (err_t err)
 
void internalOnDnsResponse (const char *name, LWIP_IP_ADDR_T *ipaddr, int port)
 

Additional Inherited Members

- Protected Attributes inherited from HttpConnection
http_parser parser
 
HttpHeaderBuilder header
 Header construction. More...
 
HttpHeaders incomingHeaders
 Full set of incoming headers. More...
 
HttpConnectionState state = eHCS_Ready
 
HttpResponse response
 
- Protected Attributes inherited from TcpClient
ReadWriteStreambuffer = nullptr
 Used internally to buffer arbitrary data via send() methods. More...
 
IDataSourceStreamstream = nullptr
 The currently active stream being sent. More...
 
- Protected Attributes inherited from TcpConnection
tcp_pcb * tcp = nullptr
 
uint16_t sleep = 0
 
uint16_t timeOut = USHRT_MAX
 By default a TCP connection does not have a time out. More...
 
bool canSend = true
 
bool autoSelfDestruct = true
 
Ssl::Sessionssl = nullptr
 
Ssl::Session::InitDelegate sslInit
 
bool useSsl = false
 
- Static Protected Attributes inherited from HttpConnection
static const http_parser_settings parserSettings
 Callback table for parser. More...
 

Constructor & Destructor Documentation

◆ HttpClientConnection()

HttpClientConnection::HttpClientConnection ( )
inline

◆ ~HttpClientConnection()

HttpClientConnection::~HttpClientConnection ( )
inline

Member Function Documentation

◆ cleanup()

void HttpClientConnection::cleanup ( )
overrideprotectedvirtual

Reimplemented from HttpConnection.

◆ connect()

bool HttpClientConnection::connect ( const String host,
int  port,
bool  useSsl = false 
)
overridevirtual

Reimplemented from TcpConnection.

◆ getRequest()

HttpRequest* HttpClientConnection::getRequest ( )
inlineoverridevirtual

Returns pointer to the current request.

Return values
HttpRequest*

Implements HttpConnection.

◆ isFinished()

bool HttpClientConnection::isFinished ( )
inline

◆ onBody()

int HttpClientConnection::onBody ( const char *  at,
size_t  length 
)
overrideprotectedvirtual

Called when a piece of body data is received.

Parameters
atthe data
length
Return values
int0 on success, non-0 on error

Implements HttpConnection.

◆ onClosed()

void HttpClientConnection::onClosed ( )
overrideprotectedvirtual

Gets called when there is/was a tcp connection, the latter does not have to be established, that is closed due to error or normal disconnect.

Note
This method can be used to trigger reconnects

Reimplemented from TcpConnection.

◆ onConnected()

err_t HttpClientConnection::onConnected ( err_t  err)
inlineoverrideprotectedvirtual

Reimplemented from TcpConnection.

◆ onHeadersComplete()

int HttpClientConnection::onHeadersComplete ( const HttpHeaders headers)
overrideprotectedvirtual

Called when all headers are received.

Parameters
headersThe processed headers
Return values
int0 on success, non-0 on error

Implements HttpConnection.

◆ onMessageBegin()

int HttpClientConnection::onMessageBegin ( http_parser *  parser)
overrideprotectedvirtual

Called when a new incoming data is beginning to come.

Parameters
parser
Return values
int0 on success, non-0 on error

Implements HttpConnection.

◆ onMessageComplete()

int HttpClientConnection::onMessageComplete ( http_parser *  parser)
overrideprotectedvirtual

Called when the incoming data is complete.

Parameters
parser
Return values
int0 on success, non-0 on error

Implements HttpConnection.

◆ onReadyToSendData()

void HttpClientConnection::onReadyToSendData ( TcpConnectionEvent  sourceEvent)
overrideprotectedvirtual

Reimplemented from TcpConnection.

◆ reset()

void HttpClientConnection::reset ( )
overridevirtual

Reimplemented from HttpConnection.

◆ send()

bool HttpClientConnection::send ( HttpRequest request)
overridevirtual

Reimplemented from HttpConnection.

◆ sslInitSession()

void HttpClientConnection::sslInitSession ( Ssl::Session session)
inlineoverrideprotectedvirtual

Override in inherited classes to perform custom session initialisation.

Called when TCP connection is established before initiating handshake.

Reimplemented from TcpConnection.


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