blob: a08960113f0c4bce1109a14f37fd800366ae4611 [file] [log] [blame]
Paul Bakker37ca75d2011-01-06 12:28:03 +00001/**
Jaeden Amero25facdd2018-01-23 15:36:58 +00002 * \file doc_tcpip.h
3 *
4 * \brief TCP/IP communication module documentation file.
5 */
6/*
Manuel Pégourié-Gonnard8119dad2015-08-06 10:59:26 +02007 *
Bence Szépkúti44bfbe32020-08-19 16:54:51 +02008 * Copyright The Mbed TLS Contributors
Bence Szépkúti4e9f7122020-06-05 13:02:18 +02009 * 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:
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020016 *
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.
Manuel Pégourié-Gonnard8119dad2015-08-06 10:59:26 +020028 *
Bence Szépkúti4e9f7122020-06-05 13:02:18 +020029 * **********
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 * **********
Paul Bakker37ca75d2011-01-06 12:28:03 +000049 */
50
51/**
52 * @addtogroup tcpip_communication_module TCP/IP communication module
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020053 *
Paul Bakker37ca75d2011-01-06 12:28:03 +000054 * The TCP/IP communication module provides for a channel of
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020055 * 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.
Paul Bakker37ca75d2011-01-06 12:28:03 +000059 * SSL/TLS resides on top of that, in the Application layer, and makes use of
60 * its basic provisions:
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +020061 * - 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()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000065 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020066 * This way you have the means to, for example, implement and use an UDP or
Paul Bakker37ca75d2011-01-06 12:28:03 +000067 * IPSec communication solution as a basis.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020068 *
Paul Bakker37ca75d2011-01-06 12:28:03 +000069 * This module can be used at server- and clientside to provide a basic
70 * means of communication over the internet.
71 */