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