TcpClient Class Reference
#include <TcpClient.h>
Inheritance diagram for TcpClient:
Collaboration diagram for TcpClient:
Public Member Functions | |
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 | |
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 | |
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 |
Constructor & Destructor Documentation
◆ TcpClient() [1/5]
|
inline |
◆ TcpClient() [2/5]
|
inline |
◆ TcpClient() [3/5]
|
inline |
◆ TcpClient() [4/5]
|
inline |
◆ TcpClient() [5/5]
|
inlineexplicit |
◆ ~TcpClient()
|
inline |
Member Function Documentation
◆ close()
|
overridevirtual |
Reimplemented from TcpConnection.
◆ commit()
|
inline |
Tries to send the pending data immediately.
- Note
- Call this method to decrease latency. Use it carefully.
◆ connect() [1/2]
Reimplemented from TcpConnection.
◆ connect() [2/2]
Reimplemented from TcpConnection.
◆ freeStreams()
|
protected |
◆ getConnectionState()
|
inline |
◆ isProcessing()
|
inline |
◆ 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()
|
overrideprotectedvirtual |
Reimplemented from TcpConnection.
◆ onError()
|
overrideprotectedvirtual |
Reimplemented from TcpConnection.
◆ onFinished()
|
protectedvirtual |
Reimplemented in MqttClient.
◆ onReadyToSendData()
|
overrideprotectedvirtual |
Reimplemented from TcpConnection.
◆ onReceive()
|
overrideprotectedvirtual |
Reimplemented from TcpConnection.
◆ onSent()
|
overrideprotectedvirtual |
Reimplemented from TcpConnection.
◆ pushAsyncPart()
|
protected |
◆ send() [1/2]
◆ send() [2/2]
bool TcpClient::send | ( | IDataSourceStream * | source, |
bool | forceCloseAfterSent = false |
||
) |
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.
◆ sendString()
◆ setCloseAfterSent()
|
inline |
Schedules the connection to get closed after the data is sent
- Parameters
-
ignoreIncomingData when that flag is set the connection will start ignoring incoming data.
◆ setCompleteDelegate()
|
inline |
Set or clear the callback for connection close.
- Parameters
-
completeCb callback delegate or nullptr
◆ setReceiveDelegate()
|
inline |
Set or clear the callback for received data.
- Parameters
-
receiveCb callback delegate or nullptr
Member Data Documentation
◆ stream
|
protected |
The currently active stream being sent.
The documentation for this class was generated from the following file: