esp-idf/components/tcp_transport/private_include/esp_transport_internal.h

66 wiersze
2.5 KiB
C

// Copyright 2020 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.
#ifndef _ESP_TRANSPORT_INTERNAL_H_
#define _ESP_TRANSPORT_INTERNAL_H_
#include "esp_transport.h"
#include "sys/queue.h"
typedef int (*get_socket_func)(esp_transport_handle_t t);
/**
* Transport layer structure, which will provide functions, basic properties for transport types
*/
struct esp_transport_item_t {
int port;
char *scheme; /*!< Tag name */
void *data; /*!< Additional transport data */
connect_func _connect; /*!< Connect function of this transport */
io_read_func _read; /*!< Read */
io_func _write; /*!< Write */
trans_func _close; /*!< Close */
poll_func _poll_read; /*!< Poll and read */
poll_func _poll_write; /*!< Poll and write */
trans_func _destroy; /*!< Destroy and free transport */
connect_async_func _connect_async; /*!< non-blocking connect function of this transport */
payload_transfer_func _parent_transfer; /*!< Function returning underlying transport layer */
get_socket_func _get_socket; /*!< Function returning the transport's socket */
struct esp_transport_error_s* error_handle; /*!< Error handle (based on esp-tls error handle)
* extended with transport's specific errors */
STAILQ_ENTRY(esp_transport_item_t) next;
};
/**
* @brief Returns underlying socket for the supplied transport handle
*
* @param t Transport handle
*
* @return Socket file descriptor in case of success
* -1 in case of error
*/
int esp_transport_get_socket(esp_transport_handle_t t);
/**
* @brief Captures the current errno
*
* @param[in] t The transport handle
* @param[in] sock_errno Socket errno to store in internal transport structures
*
*/
void esp_transport_capture_errno(esp_transport_handle_t t, int sock_errno);
#endif //_ESP_TRANSPORT_INTERNAL_H_