From f2c77bb70fc156c52e881704ac79f5cd0ede2d51 Mon Sep 17 00:00:00 2001 From: Euripedes Rocha Date: Thu, 24 Feb 2022 07:39:56 -0300 Subject: [PATCH] tcp_transport: Fix documentation for connect functions Documentation was incorrectly point that we return the socket number. The function returns an integer related to the status of the connection. Closes https://github.com/espressif/esp-idf/issues/8416 --- .../tcp_transport/include/esp_transport.h | 26 +++++++------------ tools/ci/check_copyright_ignore.txt | 1 - 2 files changed, 10 insertions(+), 17 deletions(-) diff --git a/components/tcp_transport/include/esp_transport.h b/components/tcp_transport/include/esp_transport.h index 5c7f2f77ed..e165ea11c0 100644 --- a/components/tcp_transport/include/esp_transport.h +++ b/components/tcp_transport/include/esp_transport.h @@ -1,16 +1,8 @@ -// Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at - -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +/* + * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ #ifndef _ESP_TRANSPORT_H_ #define _ESP_TRANSPORT_H_ @@ -146,7 +138,7 @@ esp_err_t esp_transport_set_default_port(esp_transport_handle_t t, int port); * @param[in] timeout_ms The timeout milliseconds (-1 indicates wait forever) * * @return - * - socket for will use by this transport + * - 0 in case of successful connection * - (-1) if there are any errors, should check errno */ int esp_transport_connect(esp_transport_handle_t t, const char *host, int port, int timeout_ms); @@ -160,8 +152,10 @@ int esp_transport_connect(esp_transport_handle_t t, const char *host, int port, * @param[in] timeout_ms The timeout milliseconds (-1 indicates wait forever) * * @return - * - socket for will use by this transport - * - (-1) if there are any errors, should check errno + * - -1 If connection establishment fails. + * - 0 If connection establishment is in progress. + * - 1 If connection establishment is successful. + * */ int esp_transport_connect_async(esp_transport_handle_t t, const char *host, int port, int timeout_ms); diff --git a/tools/ci/check_copyright_ignore.txt b/tools/ci/check_copyright_ignore.txt index 0d6d82ea79..ad02f11300 100644 --- a/tools/ci/check_copyright_ignore.txt +++ b/tools/ci/check_copyright_ignore.txt @@ -1634,7 +1634,6 @@ components/spi_flash/test/test_out_of_bounds_write.c components/spi_flash/test/test_partition_ext.c components/spi_flash/test/test_partitions.c components/spi_flash/test/test_spi_flash.c -components/tcp_transport/include/esp_transport.h components/tcp_transport/include/esp_transport_ssl.h components/tcp_transport/include/esp_transport_tcp.h components/tcp_transport/include/esp_transport_ws.h