diff options
author | David Sommerseth <dazo@users.sourceforge.net> | 2011-07-28 23:58:50 +0200 |
---|---|---|
committer | David Sommerseth <dazo@users.sourceforge.net> | 2011-07-28 23:58:50 +0200 |
commit | 3b75dec3e32e7d838ed56be5667d1cf3ac4cef18 (patch) | |
tree | 3defa3778d3b3b63061151b1f9e9d4ee1253131e /doxygen/doc_reliable.h | |
parent | 98619012e242176bcbdc3215fa462fa2cf882e36 (diff) | |
download | openvpn-3b75dec3e32e7d838ed56be5667d1cf3ac4cef18.tar.gz openvpn-3b75dec3e32e7d838ed56be5667d1cf3ac4cef18.tar.xz openvpn-3b75dec3e32e7d838ed56be5667d1cf3ac4cef18.zip |
Moved doxygen-specific files to a separate directory
Signed-off-by: Adriaan de Jong <dejong@fox-it.com>
Acked-by: David Sommerseth <dazo@users.sourceforge.net>
Signed-off-by: David Sommerseth <dazo@users.sourceforge.net>
Diffstat (limited to 'doxygen/doc_reliable.h')
-rw-r--r-- | doxygen/doc_reliable.h | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/doxygen/doc_reliable.h b/doxygen/doc_reliable.h new file mode 100644 index 0000000..5264906 --- /dev/null +++ b/doxygen/doc_reliable.h @@ -0,0 +1,49 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2010 Fox Crypto B.V. <openvpn@fox-it.com> + * + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/** + * @file + * Reliability Layer module documentation file. + */ + +/** + * @defgroup reliable Reliability Layer module + * + * The Reliability Layer is part of OpenVPN's control channel. It + * provides a reliable and sequential transport mechanism for control + * channel messages between OpenVPN peers. This module forms the + * interface between the \link external_multiplexer External + * Multiplexer\endlink and the \link control_tls Control Channel TLS + * module\endlink. + * + * @par UDP or TCP as VPN tunnel transport + * + * This is especially important when OpenVPN is configured to communicate + * over UDP, because UDP does not offer a reliable and sequential + * transport. OpenVPN endpoints can also communicate over TCP which does + * provide a reliable and sequential transport. In both cases, using UDP + * or TCP as an external transport, the internal Reliability Layer is + * active. + */ |