/** * \file doc_tcpip.h * * \brief TCP/IP communication module documentation file. */ /* * * Copyright The Mbed TLS Contributors * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later * * This file is provided under the Apache License 2.0, or the * GNU General Public License v2.0 or later. * * ********** * Apache License 2.0: * * 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. * * ********** * * ********** * GNU General Public License v2.0 or later: * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * * ********** */ /** * @addtogroup tcpip_communication_module TCP/IP communication module * * The TCP/IP communication module provides for a channel of * communication for the \link ssltls_communication_module SSL/TLS communication * module\endlink to use. * In the TCP/IP-model it provides for communication up to the Transport * (or Host-to-host) layer. * SSL/TLS resides on top of that, in the Application layer, and makes use of * its basic provisions: * - listening on a port (see \c mbedtls_net_bind()). * - accepting a connection (through \c mbedtls_net_accept()). * - read/write (through \c mbedtls_net_recv()/\c mbedtls_net_send()). * - close a connection (through \c mbedtls_net_close()). * * This way you have the means to, for example, implement and use an UDP or * IPSec communication solution as a basis. * * This module can be used at server- and clientside to provide a basic * means of communication over the internet. */