Provides http base used for client and server connections. More...
#include <HttpConnection.h>
Public Member Functions | |
HttpConnection (http_parser_type type, bool autoDestruct=false) | |
HttpConnection (tcp_pcb *connection, http_parser_type type) | |
virtual void | reset () |
virtual void | cleanup () |
virtual void | setDefaultParser () |
virtual bool | send (HttpRequest *request) |
bool | isActive () |
virtual HttpRequest * | getRequest ()=0 |
Returns pointer to the current request. More... | |
HttpResponse * | getResponse () |
Returns pointer to the current response. More... | |
IpAddress | getRemoteIp () const |
uint16_t | getRemotePort () const |
bool | send (const char *data, uint16_t len, bool forceCloseAfterSent=false) |
bool | send (IDataSourceStream *source, bool forceCloseAfterSent=false) |
Sends data stream. More... | |
![]() | |
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 | send (IDataSourceStream *source, bool forceCloseAfterSent=false) |
Sends data stream. More... | |
bool | isProcessing () |
TcpClientState | getConnectionState () |
void | setCloseAfterSent (bool ignoreIncomingData=false) |
void | commit () |
Tries to send the pending data immediately. More... | |
![]() | |
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::Session * | getSsl () |
Get a pointer to the current SSL session object. More... | |
![]() | |
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 | |
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 | onMessageBegin (http_parser *parser)=0 |
Called when a new incoming data is beginning to come. More... | |
virtual int | onPath (const Url &uri) |
Called when the URL path is known. More... | |
virtual int | onHeadersComplete (const HttpHeaders &headers)=0 |
Called when all headers are received. More... | |
virtual int | onStatus (http_parser *parser) |
virtual int | onChunkHeader (http_parser *parser) |
virtual int | onChunkComplete (http_parser *parser) |
virtual int | onBody (const char *at, size_t length)=0 |
Called when a piece of body data is received. More... | |
virtual int | onMessageComplete (http_parser *parser)=0 |
Called when the incoming data is complete. More... | |
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 |
![]() | |
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 | initialize (tcp_pcb *pcb) |
bool | internalConnect (IpAddress addr, uint16_t port) |
bool | sslCreateSession () |
virtual void | sslInitSession (Ssl::Session &session) |
Override in inherited classes to perform custom session initialisation. More... | |
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) |
Protected Attributes | |
http_parser | parser |
HttpHeaderBuilder | header |
Header construction. More... | |
HttpHeaders | incomingHeaders |
Full set of incoming headers. More... | |
HttpConnectionState | state = eHCS_Ready |
HttpResponse | response |
![]() | |
IDataSourceStream * | stream = nullptr |
The currently active stream being sent. More... | |
![]() | |
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::Session * | ssl = nullptr |
Ssl::Session::InitDelegate | sslInit |
bool | useSsl = false |
Static Protected Attributes | |
static const http_parser_settings | parserSettings |
Callback table for parser. More... | |
Detailed Description
Provides http base used for client and server connections.
Constructor & Destructor Documentation
◆ HttpConnection() [1/2]
|
inline |
◆ HttpConnection() [2/2]
|
inline |
Member Function Documentation
◆ cleanup()
|
inlinevirtual |
Reimplemented in HttpClientConnection.
◆ getRemoteIp()
|
inline |
◆ getRemotePort()
|
inline |
◆ getRequest()
|
pure virtual |
Returns pointer to the current request.
- Return values
-
HttpRequest*
Implemented in HttpServerConnection, and HttpClientConnection.
◆ getResponse()
|
inline |
Returns pointer to the current response.
- Return values
-
HttpResponse*
◆ init()
|
protectedvirtual |
Initializes the http parser for a specific type of HTTP message.
- Parameters
-
type
◆ isActive()
bool HttpConnection::isActive | ( | ) |
◆ onBody()
Called when a piece of body data is received.
- Parameters
-
at the data length
- Return values
-
int 0 on success, non-0 on error
Implemented in HttpServerConnection, and HttpClientConnection.
◆ onChunkComplete()
|
inlineprotectedvirtual |
◆ onChunkHeader()
|
inlineprotectedvirtual |
◆ onError()
|
overrideprotectedvirtual |
Reimplemented from TcpConnection.
◆ onHeadersComplete()
|
protectedpure virtual |
Called when all headers are received.
- Parameters
-
headers The processed headers
- Return values
-
int 0 on success, non-0 on error
Implemented in HttpServerConnection, and HttpClientConnection.
◆ onHttpError()
Called when there was an error.
- Parameters
-
error - the error code
- Return values
-
bool - false if the problem is not recoverable, true otherwise
Reimplemented in HttpServerConnection.
◆ onMessageBegin()
|
protectedpure virtual |
Called when a new incoming data is beginning to come.
- Parameters
-
parser
- Return values
-
int 0 on success, non-0 on error
Implemented in HttpServerConnection, and HttpClientConnection.
◆ onMessageComplete()
|
protectedpure virtual |
Called when the incoming data is complete.
- Parameters
-
parser
- Return values
-
int 0 on success, non-0 on error
Implemented in HttpServerConnection, and HttpClientConnection.
◆ onPath()
Called when the URL path is known.
- Parameters
-
uri
- Return values
-
int 0 on success, non-0 on error
Reimplemented in HttpServerConnection.
◆ onProtocolUpgrade()
|
inlineprotectedvirtual |
Called when the HTTP protocol should be upgraded.
- Parameters
-
parser
- Return values
-
bool true on success
Reimplemented in HttpServerConnection.
◆ onStatus()
|
inlineprotectedvirtual |
◆ onTcpReceive()
|
protectedvirtual |
◆ reset()
|
inlinevirtual |
Reimplemented in HttpClientConnection.
◆ resetHeaders()
|
protected |
Called after all headers have been received and processed.
◆ send() [1/3]
bool TcpClient::send |
◆ send() [2/3]
|
inlinevirtual |
Reimplemented in HttpClientConnection.
◆ send() [3/3]
bool TcpClient::send |
Sends data stream.
- Note
- This function takes ownership of the stream pointer!
- Parameters
-
source stream pointer forceCloseAfterSent
- Return values
-
bool true when the stream can be used. When false the stream will be deleted.
◆ setDefaultParser()
|
virtual |
Member Data Documentation
◆ header
|
protected |
Header construction.
◆ incomingHeaders
|
protected |
Full set of incoming headers.
◆ parser
|
protected |
◆ parserSettings
|
staticprotected |
Callback table for parser.
◆ response
|
protected |
◆ state
|
protected |
The documentation for this class was generated from the following file: