alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-30 19:19:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

tcp_transport: Fix documentation for connect functions

Browse Source 
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
This commit is contained in:
Euripedes Rocha
2022-02-24 07:39:56 -03:00
committed by David Čermák
parent fe904085fb
commit f2c77bb70f
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
//
// 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);