Liblinphone  5.5.0
Linphone.Tunnel Class Reference
Inheritance diagram for Linphone.Tunnel:
Linphone.LinphoneObject

Public Member Functions

void AddServer (Linphone.TunnelConfig tunnelConfig)
 
void CleanServers ()
 
bool Connected ()
 
void Reconnect ()
 
void RemoveServer (Linphone.TunnelConfig tunnelConfig)
 
void SetHttpProxy (string host, int port, string username, string passwd)
 
void SetHttpProxyAuthInfo (string username, string passwd)
 

Properties

bool Activated [get]
 
string Domain [get, set]
 
bool DualModeEnabled [get, set]
 
Linphone.TunnelMode Mode [get, set]
 
IEnumerable< Linphone.TunnelConfigServers [get]
 
bool SipEnabled [get, set]
 
string Username [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

Linphone tunnel object.

Member Function Documentation

void Linphone.Tunnel.AddServer ( Linphone.TunnelConfig  tunnelConfig)
inline

Add a tunnel server configuration.

Parameters
tunnelConfigLinphone.TunnelConfig object
void Linphone.Tunnel.CleanServers ( )
inline

Remove all tunnel server addresses previously entered with Linphone.Tunnel.AddServer()

bool Linphone.Tunnel.Connected ( )
inline

Check whether the tunnel is connected.

Returns
A boolean value telling if the tunnel is connected
void Linphone.Tunnel.Reconnect ( )
inline

Force reconnection to the tunnel server.

This method is useful when the device switches from wifi to Edge/3G or vice versa. In most cases the tunnel client socket won't be notified promptly that its connection is now zombie, so it is recommended to call this method that will cause the lost connection to be closed and new connection to be issued.

void Linphone.Tunnel.RemoveServer ( Linphone.TunnelConfig  tunnelConfig)
inline

Remove a tunnel server configuration.

Parameters
tunnelConfigLinphone.TunnelConfig object
void Linphone.Tunnel.SetHttpProxy ( string  host,
int  port,
string  username,
string  passwd 
)
inline

Set an optional http proxy to go through when connecting to tunnel server.

Parameters
hosthttp proxy host
porthttp proxy port
usernameOptional http proxy username if the proxy request authentication. Currently only basic authentication is supported. Use null if not needed.
passwdOptional http proxy password. Use null if not needed.
void Linphone.Tunnel.SetHttpProxyAuthInfo ( string  username,
string  passwd 
)
inline

Set authentication info for the http proxy.

Parameters
usernameUser name
passwdPassword

Property Documentation

bool Linphone.Tunnel.Activated
get

Returns whether the tunnel is activated.

If mode is set to auto, this gives indication whether the automatic detection determined that tunnel was necessary or not.

Returns
true if tunnel is in use, false otherwise.
string Linphone.Tunnel.Domain
getset

Get the domain.

Returns
The domain.
bool Linphone.Tunnel.DualModeEnabled
getset

Get the dual tunnel client mode.

Returns
true if dual tunnel client mode is enabled, false otherwise
Linphone.TunnelMode Linphone.Tunnel.Mode
getset

Get the tunnel mode.

Returns
The current Linphone.TunnelMode
IEnumerable<Linphone.TunnelConfig> Linphone.Tunnel.Servers
get

Get added servers.

Returns
The list of servers. A list of Linphone.TunnelConfig objects.
bool Linphone.Tunnel.SipEnabled
getset

Check whether tunnel is set to transport SIP packets.

Returns
A boolean value telling whether SIP packets shall pass through the tunnel
string Linphone.Tunnel.Username
getset

Get the username.

Returns
The username.

The documentation for this class was generated from the following file: