httpd_stop() function

Stops the web server Deallocates memory/resources used by an HTTP server instance and deletes it. Once deleted the handle can no longer be used for accessing the instance. Example usage:

{c}
 // Function for stopping the webserver
 void stop_webserver(httpd_handle_t server)
 {
      // Ensure handle is non NULL
      if (server != NULL) {
          // Stop the httpd server
          httpd_stop(server);
      }
 }
 

Syntax

Show:

Summary

Declaration

Definition

from esp_http_server.h:349

esp_err_t httpd_stop(httpd_handle_t handle);

Implemented in httpd_main.c:547

Arguments

Argument

Description

handle

Handle to server returned by httpd_start

Return value

- ESP_OK : Server stopped successfully - ESP_ERR_INVALID_ARG : Handle argument is Null

Examples

httpd_stop() is referenced by 5 libraries and example projects:

References

from examples

httpd_stop() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle