summaryrefslogtreecommitdiff
path: root/src/leap/services/eip/vpnlaunchers.py
diff options
context:
space:
mode:
authorkali <kali@leap.se>2013-05-03 02:59:22 +0900
committerkali <kali@leap.se>2013-05-03 02:59:22 +0900
commit96eaddedd7f09fcbcc390aedd7078aeecfa4c885 (patch)
tree90cd8f5de56207be3a2863dfd728189339f2931c /src/leap/services/eip/vpnlaunchers.py
parent90cac3e4a992a513db96b6c126fdd5259e881d0f (diff)
updated documentation
* documentation reviewed after rewrite, ready for 0.2.1 * updated docstrings format to fit sphinx autodoc
Diffstat (limited to 'src/leap/services/eip/vpnlaunchers.py')
-rw-r--r--src/leap/services/eip/vpnlaunchers.py114
1 files changed, 60 insertions, 54 deletions
diff --git a/src/leap/services/eip/vpnlaunchers.py b/src/leap/services/eip/vpnlaunchers.py
index 3d36736d..540bc45e 100644
--- a/src/leap/services/eip/vpnlaunchers.py
+++ b/src/leap/services/eip/vpnlaunchers.py
@@ -67,18 +67,18 @@ class VPNLauncher:
"""
Returns the platform dependant vpn launching command
- @param eipconfig: eip configuration object
- @type eipconfig: EIPConfig
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
- @param socket_host: either socket path (unix) or socket IP
- @type socket_host: str
- @param socket_port: either string "unix" if it's a unix
+ :param eipconfig: eip configuration object
+ :type eipconfig: EIPConfig
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
+ :param socket_host: either socket path (unix) or socket IP
+ :type socket_host: str
+ :param socket_port: either string "unix" if it's a unix
socket, or port otherwise
- @type socket_port: str
+ :type socket_port: str
- @return: A VPN command ready to be launched
- @rtype: list
+ :return: A VPN command ready to be launched
+ :rtype: list
"""
return []
@@ -89,10 +89,10 @@ class VPNLauncher:
This is mainly used for setting LD_LIBRARY_PATH to the correct
path when distributing a standalone client
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
- @rtype: dict
+ :rtype: dict
"""
return {}
@@ -148,18 +148,21 @@ class LinuxVPNLauncher(VPNLauncher):
Might raise VPNException.
- @param eipconfig: eip configuration object
- @type eipconfig: EIPConfig
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
- @param socket_host: either socket path (unix) or socket IP
- @type socket_host: str
- @param socket_port: either string "unix" if it's a unix
- socket, or port otherwise
- @type socket_port: str
+ :param eipconfig: eip configuration object
+ :type eipconfig: EIPConfig
+
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
+
+ :param socket_host: either socket path (unix) or socket IP
+ :type socket_host: str
+
+ :param socket_port: either string "unix" if it's a unix
+ socket, or port otherwise
+ :type socket_port: str
- @return: A VPN command ready to be launched
- @rtype: list
+ :return: A VPN command ready to be launched
+ :rtype: list
"""
leap_assert(eipconfig, "We need an eip config")
leap_assert_type(eipconfig, EIPConfig)
@@ -263,10 +266,10 @@ class LinuxVPNLauncher(VPNLauncher):
This is mainly used for setting LD_LIBRARY_PATH to the correct
path when distributing a standalone client
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
- @rtype: dict
+ :rtype: dict
"""
leap_assert(providerconfig, "We need a provider config")
leap_assert_type(providerconfig, ProviderConfig)
@@ -300,18 +303,21 @@ class DarwinVPNLauncher(VPNLauncher):
Might raise VPNException.
- @param eipconfig: eip configuration object
- @type eipconfig: EIPConfig
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
- @param socket_host: either socket path (unix) or socket IP
- @type socket_host: str
- @param socket_port: either string "unix" if it's a unix
- socket, or port otherwise
- @type socket_port: str
+ :param eipconfig: eip configuration object
+ :type eipconfig: EIPConfig
+
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
+
+ :param socket_host: either socket path (unix) or socket IP
+ :type socket_host: str
+
+ :param socket_port: either string "unix" if it's a unix
+ socket, or port otherwise
+ :type socket_port: str
- @return: A VPN command ready to be launched
- @rtype: list
+ :return: A VPN command ready to be launched
+ :rtype: list
"""
leap_assert(eipconfig, "We need an eip config")
leap_assert_type(eipconfig, EIPConfig)
@@ -405,10 +411,10 @@ class DarwinVPNLauncher(VPNLauncher):
This is mainly used for setting LD_LIBRARY_PATH to the correct
path when distributing a standalone client
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
- @rtype: dict
+ :rtype: dict
"""
return {"DYLD_LIBRARY_PATH": os.path.join(
providerconfig.get_path_prefix(),
@@ -431,18 +437,18 @@ class WindowsVPNLauncher(VPNLauncher):
Might raise VPNException.
- @param eipconfig: eip configuration object
- @type eipconfig: EIPConfig
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
- @param socket_host: either socket path (unix) or socket IP
- @type socket_host: str
- @param socket_port: either string "unix" if it's a unix
+ :param eipconfig: eip configuration object
+ :type eipconfig: EIPConfig
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
+ :param socket_host: either socket path (unix) or socket IP
+ :type socket_host: str
+ :param socket_port: either string "unix" if it's a unix
socket, or port otherwise
- @type socket_port: str
+ :type socket_port: str
- @return: A VPN command ready to be launched
- @rtype: list
+ :return: A VPN command ready to be launched
+ :rtype: list
"""
leap_assert(eipconfig, "We need an eip config")
leap_assert_type(eipconfig, EIPConfig)
@@ -514,10 +520,10 @@ class WindowsVPNLauncher(VPNLauncher):
This is mainly used for setting LD_LIBRARY_PATH to the correct
path when distributing a standalone client
- @param providerconfig: provider specific configuration
- @type providerconfig: ProviderConfig
+ :param providerconfig: provider specific configuration
+ :type providerconfig: ProviderConfig
- @rtype: dict
+ :rtype: dict
"""
return {}