doc_tcpip.h 1.7 KB

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