| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| 2 | * @file |
| 3 | * TCP/IP communication module documentation file. |
| 4 | */ |
| 5 | |
| 6 | /** |
| 7 | * @addtogroup tcpip_communication_module TCP/IP communication module |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 8 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 9 | * The TCP/IP communication module provides for a channel of |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 10 | * communication for the \link ssltls_communication_module SSL/TLS communication |
| 11 | * module\endlink to use. |
| 12 | * In the TCP/IP-model it provides for communication up to the Transport |
| 13 | * (or Host-to-host) layer. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 14 | * SSL/TLS resides on top of that, in the Application layer, and makes use of |
| 15 | * its basic provisions: |
| Manuel Pégourié-Gonnard | 151dc77 | 2015-05-14 13:55:51 +0200 | [diff] [blame] | 16 | * - listening on a port (see \c mbedtls_net_bind()). |
| 17 | * - accepting a connection (through \c mbedtls_net_accept()). |
| 18 | * - read/write (through \c mbedtls_net_recv()/\c mbedtls_net_send()). |
| 19 | * - close a connection (through \c mbedtls_net_close()). |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 20 | * |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 21 | * This way you have the means to, for example, implement and use an UDP or |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 22 | * IPSec communication solution as a basis. |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 23 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 24 | * This module can be used at server- and clientside to provide a basic |
| 25 | * means of communication over the internet. |
| 26 | */ |