0
0
mirror of https://github.com/OpenVPN/openvpn.git synced 2024-09-20 03:52:28 +02:00
openvpn/doc/doxygen/doc_eventloop.h
David Sommerseth 05271322e7 Update copyrights
- Update the update-copyright script to include more contributors as well
  as correcting a few typos

- Correct a copyright address in the source code to now used address
  (dazo)

- Update copyright year to 2021

Signed-off-by: David Sommerseth <davids@openvpn.net>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <20210609213231.22576-1-openvpn@sf.lists.topphemmelig.net>
URL: https://www.mail-archive.com/search?l=mid&q=20210609213231.22576-1-openvpn@sf.lists.topphemmelig.net
URL: https://sourceforge.net/p/openvpn/mailman/message/37299719/
Signed-off-by: Gert Doering <gert@greenie.muc.de>
2021-06-15 10:41:07 +02:00

67 lines
2.9 KiB
C

/*
* 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-2021 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; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/**
* @file
* Main Event Loop module documentation file.
*/
/**
* @defgroup eventloop Main Event Loop module
*
* This main event loop module drives the packet processing of OpenVPN.
*
* OpenVPN is an event driven system. Its activities are driven by a main
* event loop, which repeatedly waits for one of several predefined events
* to occur, and then calls the appropriate module to handle the event.
* The major types of network events that OpenVPN processes are:
* - A packet can be read from the external network interface.
* - The main event loop activates the \link external_multiplexer
* External Multiplexer\endlink to read and process the packet.
* - A packet can be read from the virtual tun/tap network interface.
* - The main event loop activates the \link internal_multiplexer
* Internal Multiplexer\endlink to read and process the packet.
* - If a packet is ready to be sent out as a VPN tunnel packet: the
* external network interface can be written to.
* - The main event loop activates the \link external_multiplexer
* External Multiplexer\endlink to send the packet.
* - If a packet is ready to be sent to a locally reachable destination:
* the virtual tun/tap network interface can be written to.
* - The main event loop activates the \link internal_multiplexer
* Internal Multiplexer\endlink to send the packet.
*
* Beside these external events, OpenVPN also processes other types of
* internal events. These include scheduled events, such as resending of
* non-acknowledged control channel messages.
*
* @par Main event loop implementations
*
* Depending on the mode in which OpenVPN is running, a different main
* event loop function is called to drive the event processing. The
* following implementations are available:
* - Client mode using UDP or TCP: \c tunnel_point_to_point()
* - Server mode using UDP: \c tunnel_server_udp()
* - Server mode using TCP: \c tunnel_server_tcp()
*/