espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-04 21:24:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'bugfix/tcp_transport_documentation' into 'master'

Browse Source 
tcp_transport: Fix documentation for connect functions

See merge request espressif/esp-idf!17270
This commit is contained in:
David Čermák
2022-04-30 07:45:21 +08:00
parent 4bb8bbc682 f2c77bb70f
commit 2941cd353a
2 changed files with 10 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
components/tcp_transport/include/esp_transport.h
View File

@@ -1,16 +1,8 @@
// Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD /*
// * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
// Licensed under the Apache License, Version 2.0 (the "License"); *
// you may not use this file except in compliance with the License. * SPDX-License-Identifier: Apache-2.0
// 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.
#ifndef _ESP_TRANSPORT_H_ #ifndef _ESP_TRANSPORT_H_
#define _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) * @param[in] timeout_ms The timeout milliseconds (-1 indicates wait forever)
* *
* @return * @return
* - socket for will use by this transport * - 0 in case of successful connection
* - (-1) if there are any errors, should check errno * - (-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); 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) * @param[in] timeout_ms The timeout milliseconds (-1 indicates wait forever)
* *
* @return * @return
* - socket for will use by this transport * - -1 If connection establishment fails.
* - (-1) if there are any errors, should check errno * - 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); int esp_transport_connect_async(esp_transport_handle_t t, const char *host, int port, int timeout_ms);

1
tools/ci/check_copyright_ignore.txt
View File

@@ -1611,7 +1611,6 @@ components/spi_flash/test/test_out_of_bounds_write.c
components/spi_flash/test/test_partition_ext.c components/spi_flash/test/test_partition_ext.c
components/spi_flash/test/test_partitions.c components/spi_flash/test/test_partitions.c
components/spi_flash/test/test_spi_flash.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_ssl.h
components/tcp_transport/include/esp_transport_tcp.h components/tcp_transport/include/esp_transport_tcp.h
components/tcp_transport/include/esp_transport_ws.h components/tcp_transport/include/esp_transport_ws.h