blob: c9309a770f6d29911603f2013bb27efdcc6f2b8f [file] [log] [blame]
Paul Bakker37ca75d2011-01-06 12:28:03 +00001/**
2 * @file
3 * TCP/IP communication module documentation file.
4 */
5
6/**
7 * @addtogroup tcpip_communication_module TCP/IP communication module
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02008 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00009 * The TCP/IP communication module provides for a channel of
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020010 * 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 Bakker37ca75d2011-01-06 12:28:03 +000014 * SSL/TLS resides on top of that, in the Application layer, and makes use of
15 * its basic provisions:
16 * - listening on a port (see \c net_bind()).
17 * - accepting a connection (through \c net_accept()).
Paul Bakkerf3b86c12011-01-27 15:24:17 +000018 * - read/write (through \c net_recv()/\c net_send()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000019 * - close a connection (through \c net_close()).
20 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020021 * This way you have the means to, for example, implement and use an UDP or
Paul Bakker37ca75d2011-01-06 12:28:03 +000022 * IPSec communication solution as a basis.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020023 *
Paul Bakker37ca75d2011-01-06 12:28:03 +000024 * This module can be used at server- and clientside to provide a basic
25 * means of communication over the internet.
26 */