1 /** 2 * \file doc_tcpip.h 3 * 4 * \brief TCP/IP communication module documentation file. 5 */ 6 /* 7 * 8 * Copyright The Mbed TLS Contributors 9 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 10 * 11 * This file is provided under the Apache License 2.0, or the 12 * GNU General Public License v2.0 or later. 13 * 14 * ********** 15 * Apache License 2.0: 16 * 17 * Licensed under the Apache License, Version 2.0 (the "License"); you may 18 * not use this file except in compliance with the License. 19 * You may obtain a copy of the License at 20 * 21 * http://www.apache.org/licenses/LICENSE-2.0 22 * 23 * Unless required by applicable law or agreed to in writing, software 24 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 25 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 26 * See the License for the specific language governing permissions and 27 * limitations under the License. 28 * 29 * ********** 30 * 31 * ********** 32 * GNU General Public License v2.0 or later: 33 * 34 * This program is free software; you can redistribute it and/or modify 35 * it under the terms of the GNU General Public License as published by 36 * the Free Software Foundation; either version 2 of the License, or 37 * (at your option) any later version. 38 * 39 * This program is distributed in the hope that it will be useful, 40 * but WITHOUT ANY WARRANTY; without even the implied warranty of 41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42 * GNU General Public License for more details. 43 * 44 * You should have received a copy of the GNU General Public License along 45 * with this program; if not, write to the Free Software Foundation, Inc., 46 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 47 * 48 * ********** 49 */ 50 51 /** 52 * @addtogroup tcpip_communication_module TCP/IP communication module 53 * 54 * The TCP/IP communication module provides for a channel of 55 * communication for the \link ssltls_communication_module SSL/TLS communication 56 * module\endlink to use. 57 * In the TCP/IP-model it provides for communication up to the Transport 58 * (or Host-to-host) layer. 59 * SSL/TLS resides on top of that, in the Application layer, and makes use of 60 * its basic provisions: 61 * - listening on a port (see \c mbedtls_net_bind()). 62 * - accepting a connection (through \c mbedtls_net_accept()). 63 * - read/write (through \c mbedtls_net_recv()/\c mbedtls_net_send()). 64 * - close a connection (through \c mbedtls_net_close()). 65 * 66 * This way you have the means to, for example, implement and use an UDP or 67 * IPSec communication solution as a basis. 68 * 69 * This module can be used at server- and clientside to provide a basic 70 * means of communication over the internet. 71 */ 72