Willie Solano / mbedtls-slave-prot-prod

mbed TLS Build

Dependents:   Slave-prot-prod

doxygen/input/doc_tcpip.h@0:cdf462088d13, 2017-01-05 (annotated)

Committer:
markrad
Date:
Thu Jan 05 00:18:44 2017 +0000
Revision:
0:cdf462088d13
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
markrad 0:cdf462088d13 1 /**
markrad 0:cdf462088d13 2 * @file
markrad 0:cdf462088d13 3 * TCP/IP communication module documentation file.
markrad 0:cdf462088d13 4 *
markrad 0:cdf462088d13 5 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
markrad 0:cdf462088d13 6 * SPDX-License-Identifier: Apache-2.0
markrad 0:cdf462088d13 7 *
markrad 0:cdf462088d13 8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
markrad 0:cdf462088d13 9 * not use this file except in compliance with the License.
markrad 0:cdf462088d13 10 * You may obtain a copy of the License at
markrad 0:cdf462088d13 11 *
markrad 0:cdf462088d13 12 * http://www.apache.org/licenses/LICENSE-2.0
markrad 0:cdf462088d13 13 *
markrad 0:cdf462088d13 14 * Unless required by applicable law or agreed to in writing, software
markrad 0:cdf462088d13 15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
markrad 0:cdf462088d13 16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
markrad 0:cdf462088d13 17 * See the License for the specific language governing permissions and
markrad 0:cdf462088d13 18 * limitations under the License.
markrad 0:cdf462088d13 19 *
markrad 0:cdf462088d13 20 * This file is part of mbed TLS (https://tls.mbed.org)
markrad 0:cdf462088d13 21 */
markrad 0:cdf462088d13 22
markrad 0:cdf462088d13 23 /**
markrad 0:cdf462088d13 24 * @addtogroup tcpip_communication_module TCP/IP communication module
markrad 0:cdf462088d13 25 *
markrad 0:cdf462088d13 26 * The TCP/IP communication module provides for a channel of
markrad 0:cdf462088d13 27 * communication for the \link ssltls_communication_module SSL/TLS communication
markrad 0:cdf462088d13 28 * module\endlink to use.
markrad 0:cdf462088d13 29 * In the TCP/IP-model it provides for communication up to the Transport
markrad 0:cdf462088d13 30 * (or Host-to-host) layer.
markrad 0:cdf462088d13 31 * SSL/TLS resides on top of that, in the Application layer, and makes use of
markrad 0:cdf462088d13 32 * its basic provisions:
markrad 0:cdf462088d13 33 * - listening on a port (see \c mbedtls_net_bind()).
markrad 0:cdf462088d13 34 * - accepting a connection (through \c mbedtls_net_accept()).
markrad 0:cdf462088d13 35 * - read/write (through \c mbedtls_net_recv()/\c mbedtls_net_send()).
markrad 0:cdf462088d13 36 * - close a connection (through \c mbedtls_net_close()).
markrad 0:cdf462088d13 37 *
markrad 0:cdf462088d13 38 * This way you have the means to, for example, implement and use an UDP or
markrad 0:cdf462088d13 39 * IPSec communication solution as a basis.
markrad 0:cdf462088d13 40 *
markrad 0:cdf462088d13 41 * This module can be used at server- and clientside to provide a basic
markrad 0:cdf462088d13 42 * means of communication over the internet.
markrad 0:cdf462088d13 43 */