| orphan: |
|---|
Methods documented for Client in Arduino
Methods and properties described further down below are specific to ESP8266. Some of them behave differently from the reference Arduino WiFi library , or are only implemented for this Core.
Unlike the reference implementation, connected() means that the client is available for both reads and writes. It will return true when the client is status() == ESTABLISHED or available() == true, but will return false when the status() == CLOSED. Please use status() for the connection information, availableForWrite() to check whether it is possible to write, and available() if you mean to check whether there's unread data.
When the remote side closes the connection e.g. we receive a fairly small payload through HTTP with Connection: close, client will return connected() == false while the available() > 0. Attempting to write() to such connection will not be possible, so it is expected from the sketch to check first for the availableForWrite() > 0.
This change was introduced with #4626, part of the Core release 2.4.2
Current implementation returns 0 / CLOSED when the client is disconnected and 4 / ESTABLISHED when connected. At the time of writing these refer to the enum tcp_state values that can be found at the lwip/tcpbase.h
flush(timeoutMs) and stop(timeoutMs) both have now an optional argument: timeout in millisecond, and both return a boolean.
Default input value 0 means that effective value is left at the discretion of the implementer.
flush() returning true indicates that output data have effectively been sent, and false that a timeout has occurred.
stop() returns false in case of an issue when closing the client (for instance a timed-out flush). Depending on implementation, its parameter can be passed to flush().
setNoDelay(nodelay)With nodelay set to true, this function will to disable Nagle algorithm.
This algorithm is intended to reduce TCP/IP traffic of small packets sent over the network by combining a number of small outgoing messages, and sending them all at once. The downside of such approach is effectively delaying individual messages until a big enough packet is assembled.
Example:
client.setNoDelay(true);Returns whether NoDelay is enabled or not for the current connection.
This is an experimental API that will set the client in synchronized mode.
In this mode, every write() is flushed. It means that after a call to
write(), data are ensured to be received where they went sent to (that is
flush semantic).
When set to true in WiFiClient implementation,
- It slows down transfers, and implicitly disable the Nagle algorithm.
- It also allows to avoid a temporary copy of data that otherwise consumes
at most
TCP_SND_BUF= (2 *MSS) bytes per connection,
Returns whether Sync is enabled or not for the current connection.
These set the default value for both setSync and setNoDelay for
every future instance of WiFiClient (including those coming from
WiFiServer.available() by default).
Default values are false for both NoDelay and Sync.
This means that Nagle is enabled by default for all new connections.
Return the values to be used as default for NoDelay and Sync for all future connections.
virtual size_t write (const uint8_t *buf, size_t size)
size_t write_P (PGM_P buf, size_t size)
size_t write (Stream &stream)
size_t write (Stream &stream, size_t unitSize) __attribute__((deprecated))
virtual int read (uint8_t *buf, size_t size)
virtual int peek ()
virtual size_t peekBytes (uint8_t *buffer, size_t length)
size_t peekBytes (char *buffer, size_t length)
virtual operator bool ()
IPAddress remoteIP ()
uint16_t remotePort ()
IPAddress localIP ()
uint16_t localPort ()Documentation for the above functions is not yet available.