The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Net-OpenVPN-Launcher-0.12
River stage one • 1 direct dependent • 1 total dependent
++
/ Net::OpenVPN::Launcher

VERSION

Version 0.12

NAME

Net::OpenVPN::Launcher - start, stop and restart OpenVPN as a sub-process.

SYNOPSIS

    use Net::OpenVPN::Launcher;

    my $pm = Net::OpenVPN::Launcher->new;

    $pm->start($filepath_to_config_file);

    # do some stuff

    # now stop the first instance of OpenVPN and start another
    $pm->start($filepath_to_alt_config_file);

    # do some stuff

    $pm->stop;

DESCRIPTION

Net::OpenVPN::Launcher is an object oriented module that provides methods to start, stop and restart OpenVPN. It's useful because it runs OpenVPN processes as a non-blocking sub-process. This allows you to start and stop several OpenVPN processes within the same Perl program.

SYSTEM REQUIREMENTS

  • OpenVPN needs to be installed and in $PATH (or in bin, in $PATH).

  • This module has been tested on OpenVPN version 2.2.1 - it should work with most versions of OpenVPN.

  • Currently only works with Linux-like operating systems.

  • By default OpenVPN needs to be run with root privileges, hence any Perl program using this module will need to be run as root unless OpenVPN has been configured to run under user privileges.

METHODS

start

Initialises OpenVPN with a config file. Requires a filepath to an OpenVPN config file. See the OpenVPN documentation for example config files and options.

    $pm->start('openvpn.conf');

restart

Restarts the existing OpenVPN process with the same configuration file as before.

    $pm->restart;

stop

Kills the OpenVPN process.

    $pm->stop;

INTERNAL METHODS

DEMOLISH

This method is called on object destruction and it will call the stop method if any active openvpn processes are found. This means it is not necessary to call the stop method when exiting the program.

config

This is a getter/setter method for the filepath to the OpenVPN configuration file.

openvpn_pid

This is a getter/setter method for the PID of the openvpn process.

AUTHOR

David Farrell, <davidnmfarrell at gmail.com>, perltricks.com

BUGS

Please report any bugs or feature requests to bug-net-openvpn-proxymanager at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-OpenVPN-Launcher. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Net::OpenVPN::Launcher

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2013 David Farrell.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.