1a8e1175bSopenharmony_ci/** 2a8e1175bSopenharmony_ci * \file doc_tcpip.h 3a8e1175bSopenharmony_ci * 4a8e1175bSopenharmony_ci * \brief TCP/IP communication module documentation file. 5a8e1175bSopenharmony_ci */ 6a8e1175bSopenharmony_ci/* 7a8e1175bSopenharmony_ci * 8a8e1175bSopenharmony_ci * Copyright The Mbed TLS Contributors 9a8e1175bSopenharmony_ci * SPDX-License-Identifier: Apache-2.0 10a8e1175bSopenharmony_ci * 11a8e1175bSopenharmony_ci * Licensed under the Apache License, Version 2.0 (the "License"); you may 12a8e1175bSopenharmony_ci * not use this file except in compliance with the License. 13a8e1175bSopenharmony_ci * You may obtain a copy of the License at 14a8e1175bSopenharmony_ci * 15a8e1175bSopenharmony_ci * http://www.apache.org/licenses/LICENSE-2.0 16a8e1175bSopenharmony_ci * 17a8e1175bSopenharmony_ci * Unless required by applicable law or agreed to in writing, software 18a8e1175bSopenharmony_ci * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 19a8e1175bSopenharmony_ci * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20a8e1175bSopenharmony_ci * See the License for the specific language governing permissions and 21a8e1175bSopenharmony_ci * limitations under the License. 22a8e1175bSopenharmony_ci */ 23a8e1175bSopenharmony_ci 24a8e1175bSopenharmony_ci/** 25a8e1175bSopenharmony_ci * @addtogroup tcpip_communication_module TCP/IP communication module 26a8e1175bSopenharmony_ci * 27a8e1175bSopenharmony_ci * The TCP/IP communication module provides for a channel of 28a8e1175bSopenharmony_ci * communication for the \link ssltls_communication_module SSL/TLS communication 29a8e1175bSopenharmony_ci * module\endlink to use. 30a8e1175bSopenharmony_ci * In the TCP/IP-model it provides for communication up to the Transport 31a8e1175bSopenharmony_ci * (or Host-to-host) layer. 32a8e1175bSopenharmony_ci * SSL/TLS resides on top of that, in the Application layer, and makes use of 33a8e1175bSopenharmony_ci * its basic provisions: 34a8e1175bSopenharmony_ci * - listening on a port (see \c mbedtls_net_bind()). 35a8e1175bSopenharmony_ci * - accepting a connection (through \c mbedtls_net_accept()). 36a8e1175bSopenharmony_ci * - read/write (through \c mbedtls_net_recv()/\c mbedtls_net_send()). 37a8e1175bSopenharmony_ci * - close a connection (through \c mbedtls_net_close()). 38a8e1175bSopenharmony_ci * 39a8e1175bSopenharmony_ci * This way you have the means to, for example, implement and use an UDP or 40a8e1175bSopenharmony_ci * IPSec communication solution as a basis. 41a8e1175bSopenharmony_ci * 42a8e1175bSopenharmony_ci * This module can be used at server- and clientside to provide a basic 43a8e1175bSopenharmony_ci * means of communication over the internet. 44a8e1175bSopenharmony_ci */ 45