#include <TcpClient.h>

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

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 isProcessing ()
 
TcpClientState getConnectionState ()
 
void setCloseAfterSent (bool ignoreIncomingData=false)
 
int writeString (const char *data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 
int writeString (const String &data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 
virtual int write (const char *data, int len, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Base write operation. More...
 
int write (IDataSourceStream *stream)
 
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...
 

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 onReadyToSendData (TcpConnectionEvent sourceEvent) override
 
virtual void onFinished (TcpClientState finishState)
 
void pushAsyncPart ()
 
void freeStreams ()
 
void setBuffer (ReadWriteStream *stream)
 
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

ReadWriteStreambuffer = nullptr
 Used internally to buffer arbitrary data via send() methods. More...
 
IDataSourceStreamstream = 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::Sessionssl = nullptr
 
Ssl::Session::InitDelegate sslInit
 
bool useSsl = false
 

Constructor & Destructor Documentation

◆ TcpClient() [1/5]

TcpClient::TcpClient ( bool  autoDestruct)
inline

◆ TcpClient() [2/5]

TcpClient::TcpClient ( tcp_pcb *  clientTcp,
TcpClientDataDelegate  clientReceive,
TcpClientCompleteDelegate  onCompleted 
)
inline

◆ TcpClient() [3/5]

TcpClient::TcpClient ( TcpClientCompleteDelegate  onCompleted,
TcpClientEventDelegate  onReadyToSend,
TcpClientDataDelegate  onReceive = nullptr 
)
inline

◆ TcpClient() [4/5]

TcpClient::TcpClient ( TcpClientCompleteDelegate  onCompleted,
TcpClientDataDelegate  onReceive = nullptr 
)
inline

◆ TcpClient() [5/5]

TcpClient::TcpClient ( TcpClientDataDelegate  onReceive)
inlineexplicit

◆ ~TcpClient()

TcpClient::~TcpClient ( )
inline

Member Function Documentation

◆ close()

void TcpClient::close ( )
overridevirtual

Reimplemented from TcpConnection.

◆ connect() [1/2]

bool TcpClient::connect ( const String server,
int  port,
bool  useSsl = false 
)
overridevirtual

Reimplemented from TcpConnection.

◆ connect() [2/2]

bool TcpClient::connect ( IpAddress  addr,
uint16_t  port,
bool  useSsl = false 
)
overridevirtual

Reimplemented from TcpConnection.

◆ flush()

void TcpConnection::flush ( )
inherited

◆ freeStreams()

void TcpClient::freeStreams ( )
protected

◆ getAvailableWriteSize()

uint16_t TcpConnection::getAvailableWriteSize ( )
inlineinherited

◆ getConnectionState()

TcpClientState TcpClient::getConnectionState ( )
inline

◆ getRemoteIp()

IpAddress TcpConnection::getRemoteIp ( ) const
inlineinherited

◆ getRemotePort()

uint16_t TcpConnection::getRemotePort ( ) const
inlineinherited

◆ getSsl()

Ssl::Session* TcpConnection::getSsl ( )
inlineinherited

Get a pointer to the current SSL session object.

Note that this is typically used so we can query properties of an established session. If you need to change session parameters this must be done via setSslInitHandler.

◆ initialize()

void TcpConnection::initialize ( tcp_pcb *  pcb)
protectedinherited

◆ internalConnect()

bool TcpConnection::internalConnect ( IpAddress  addr,
uint16_t  port 
)
protectedinherited

◆ internalOnConnected()

err_t TcpConnection::internalOnConnected ( err_t  err)
protectedinherited

◆ internalOnDnsResponse()

void TcpConnection::internalOnDnsResponse ( const char *  name,
LWIP_IP_ADDR_T ipaddr,
int  port 
)
protectedinherited

◆ internalOnError()

void TcpConnection::internalOnError ( err_t  err)
protectedinherited

◆ internalOnPoll()

err_t TcpConnection::internalOnPoll ( )
protectedinherited

◆ internalOnReceive()

err_t TcpConnection::internalOnReceive ( pbuf *  p,
err_t  err 
)
protectedinherited

◆ internalOnSent()

err_t TcpConnection::internalOnSent ( uint16_t  len)
protectedinherited

◆ isProcessing()

bool TcpClient::isProcessing ( )
inline

◆ onConnected()

err_t TcpClient::onConnected ( err_t  err)
overrideprotectedvirtual

Reimplemented from TcpConnection.

◆ onError()

void TcpClient::onError ( err_t  err)
overrideprotectedvirtual

Reimplemented from TcpConnection.

◆ onFinished()

virtual void TcpClient::onFinished ( TcpClientState  finishState)
protectedvirtual

Reimplemented in MqttClient.

◆ onPoll()

virtual err_t TcpConnection::onPoll ( )
protectedvirtualinherited

◆ onReadyToSendData()

void TcpClient::onReadyToSendData ( TcpConnectionEvent  sourceEvent)
overrideprotectedvirtual

Reimplemented from TcpConnection.

◆ onReceive()

err_t TcpClient::onReceive ( pbuf *  buf)
overrideprotectedvirtual

Reimplemented from TcpConnection.

◆ onSent()

err_t TcpClient::onSent ( uint16_t  len)
overrideprotectedvirtual

Reimplemented from TcpConnection.

◆ pushAsyncPart()

void TcpClient::pushAsyncPart ( )
protected

◆ send()

bool TcpClient::send ( const char *  data,
uint16_t  len,
bool  forceCloseAfterSent = false 
)

◆ sendString()

bool TcpClient::sendString ( const String data,
bool  forceCloseAfterSent = false 
)
inline

◆ setBuffer()

void TcpClient::setBuffer ( ReadWriteStream stream)
protected

◆ setCloseAfterSent()

void TcpClient::setCloseAfterSent ( bool  ignoreIncomingData = false)
inline

Schedules the connection to get closed after the data is sent

Parameters
ignoreIncomingDatawhen that flag is set the connection will start ignoring incoming data.

◆ setCompleteDelegate()

void TcpClient::setCompleteDelegate ( TcpClientCompleteDelegate  completeCb = nullptr)
inline

Set or clear the callback for connection close.

Parameters
completeCbcallback delegate or nullptr

◆ setDestroyedDelegate()

void TcpConnection::setDestroyedDelegate ( TcpConnectionDestroyedDelegate  destroyedDelegate)
inlineinherited

Sets a callback to be called when the object instance is destroyed.

Parameters
destroyedDelegate

◆ setReceiveDelegate()

void TcpClient::setReceiveDelegate ( TcpClientDataDelegate  receiveCb = nullptr)
inline

Set or clear the callback for received data.

Parameters
receiveCbcallback delegate or nullptr

◆ setSslConnection()

bool TcpConnection::setSslConnection ( Ssl::Connection connection)
inlineinherited

◆ setSslInitHandler()

void TcpConnection::setSslInitHandler ( Ssl::Session::InitDelegate  handler)
inlineinherited

Set the SSL session initialisation callback.

Parameters
handler

◆ setTimeOut()

void TcpConnection::setTimeOut ( uint16_t  waitTimeOut)
inherited

◆ sslCreateSession()

bool TcpConnection::sslCreateSession ( )
protectedinherited

◆ sslInitSession()

virtual void TcpConnection::sslInitSession ( Ssl::Session session)
inlineprotectedvirtualinherited

Override in inherited classes to perform custom session initialisation.

Called when TCP connection is established before initiating handshake.

Reimplemented in HttpClientConnection.

◆ trySend()

void TcpConnection::trySend ( TcpConnectionEvent  event)
inlineprotectedinherited

◆ write() [1/2]

virtual int TcpConnection::write ( const char *  data,
int  len,
uint8_t  apiflags = TCP_WRITE_FLAG_COPY 
)
virtualinherited

Base write operation.

Parameters
data
len
apiflagsTCP_WRITE_FLAG_COPY, TCP_WRITE_FLAG_MORE
Return values
int-1 on error

Reimplemented in FtpDataStream.

◆ write() [2/2]

int TcpConnection::write ( IDataSourceStream stream)
inherited

◆ writeString() [1/2]

int TcpConnection::writeString ( const char *  data,
uint8_t  apiflags = TCP_WRITE_FLAG_COPY 
)
inlineinherited

◆ writeString() [2/2]

int TcpConnection::writeString ( const String data,
uint8_t  apiflags = TCP_WRITE_FLAG_COPY 
)
inlineinherited

Member Data Documentation

◆ autoSelfDestruct

bool TcpConnection::autoSelfDestruct = true
protectedinherited

◆ buffer

ReadWriteStream* TcpClient::buffer = nullptr
protected

Used internally to buffer arbitrary data via send() methods.

◆ canSend

bool TcpConnection::canSend = true
protectedinherited

◆ sleep

uint16_t TcpConnection::sleep = 0
protectedinherited

◆ ssl

Ssl::Session* TcpConnection::ssl = nullptr
protectedinherited

◆ sslInit

Ssl::Session::InitDelegate TcpConnection::sslInit
protectedinherited

◆ stream

IDataSourceStream* TcpClient::stream = nullptr
protected

The currently active stream being sent.

◆ tcp

tcp_pcb* TcpConnection::tcp = nullptr
protectedinherited

◆ timeOut

uint16_t TcpConnection::timeOut = USHRT_MAX
protectedinherited

By default a TCP connection does not have a time out.

◆ useSsl

bool TcpConnection::useSsl = false
protectedinherited

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