doc_tcpip.h

00001 /**
00002  * @file
00003  * TCP/IP communication module documentation file.
00004  *
00005  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
00006  *  SPDX-License-Identifier: Apache-2.0
00007  *
00008  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
00009  *  not use this file except in compliance with the License.
00010  *  You may obtain a copy of the License at
00011  *
00012  *  http://www.apache.org/licenses/LICENSE-2.0
00013  *
00014  *  Unless required by applicable law or agreed to in writing, software
00015  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00016  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00017  *  See the License for the specific language governing permissions and
00018  *  limitations under the License.
00019  *
00020  *  This file is part of mbed TLS (https://tls.mbed.org)
00021  */
00022 
00023 /**
00024  * @addtogroup tcpip_communication_module TCP/IP communication module
00025  *
00026  * The TCP/IP communication module provides for a channel of
00027  * communication for the \link ssltls_communication_module SSL/TLS communication
00028  * module\endlink to use.
00029  * In the TCP/IP-model it provides for communication up to the Transport
00030  * (or Host-to-host) layer.
00031  * SSL/TLS resides on top of that, in the Application layer, and makes use of
00032  * its basic provisions:
00033  * - listening on a port (see \c mbedtls_net_bind()).
00034  * - accepting a connection (through \c mbedtls_net_accept()).
00035  * - read/write (through \c mbedtls_net_recv()/\c mbedtls_net_send()).
00036  * - close a connection (through \c mbedtls_net_close()).
00037  *
00038  * This way you have the means to, for example, implement and use an UDP or
00039  * IPSec communication solution as a basis.
00040  *
00041  * This module can be used at server- and clientside to provide a basic
00042  * means of communication over the internet.
00043  */