httpd_socket_recv() function

A low level API to receive data from a given socket This internally calls the default recv function, or the function registered by httpd_sess_set_recv_override().

Syntax

Show:

Summary

Declaration

Definition

from esp_http_server.h:1480

int httpd_socket_recv(httpd_handle_t hd, int sockfd, char *buf, size_t buf_len, int flags);

Implemented in httpd_txrx.c:738

Arguments

Argument

Description

server instance

sockfd

session socket file descriptor

buf

buffer with bytes to send

buf_len

data size

flags

flags for the send() function

Return value

- Bytes : The number of bytes received successfully - 0 : Buffer length parameter is zero / connection closed by peer - HTTPD_SOCK_ERR_INVALID : Invalid arguments - HTTPD_SOCK_ERR_TIMEOUT : Timeout/interrupted while calling socket recv() - HTTPD_SOCK_ERR_FAIL : Unrecoverable error while calling socket recv()

Notes

This API is not recommended to be used in any request handler. Use this only for advanced use cases, wherein some asynchronous communication is required.

Examples

References

from examples

httpd_socket_recv() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle