<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>liblinphone: Managing proxies</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">liblinphone
 <span id="projectnumber">3.5.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Managing proxies</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga1879a0d59e068457b688138da97f2d0b"><td class="memItemLeft" align="right" valign="top">typedef struct _LinphoneProxyConfig </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a></td></tr>
<tr class="memitem:ga698cb4228fac724b9e7c3cc5f499f7a8"><td class="memItemLeft" align="right" valign="top">typedef enum <br class="typebreak"/>
<a class="el" href="group__proxies.html#gaea1b64a739b1faf0b490fe0f52cfe65e">_LinphoneRegistrationState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga698cb4228fac724b9e7c3cc5f499f7a8">LinphoneRegistrationState</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaea1b64a739b1faf0b490fe0f52cfe65e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaea1b64a739b1faf0b490fe0f52cfe65e">_LinphoneRegistrationState</a> { <br/>
  <a class="el" href="group__proxies.html#ggaea1b64a739b1faf0b490fe0f52cfe65ea07341285f0270fe6e3b1e21949725d54">LinphoneRegistrationNone</a>,
<br/>
  <a class="el" href="group__proxies.html#ggaea1b64a739b1faf0b490fe0f52cfe65eae20dab1677f285ef32006cc86f8ea630">LinphoneRegistrationProgress</a>,
<br/>
  <a class="el" href="group__proxies.html#ggaea1b64a739b1faf0b490fe0f52cfe65ea73e009ef868a552c580b179578b87366">LinphoneRegistrationOk</a>,
<br/>
  <a class="el" href="group__proxies.html#ggaea1b64a739b1faf0b490fe0f52cfe65eaf08a66584f81f4bbc9bfd1e3166c348d">LinphoneRegistrationCleared</a>,
<br/>
  <a class="el" href="group__proxies.html#ggaea1b64a739b1faf0b490fe0f52cfe65eaa9861e7fe94dd55d5e9f7e58119abe5d">LinphoneRegistrationFailed</a>
<br/>
}</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8ff876ddd266a66e315fe0576537fb77"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga8ff876ddd266a66e315fe0576537fb77">linphone_core_set_primary_contact</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc, const char *contact)</td></tr>
<tr class="memitem:ga147c072e33bdf5d44a3b95b28b4b27a1"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga147c072e33bdf5d44a3b95b28b4b27a1">linphone_core_get_primary_contact</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
<tr class="memitem:gace31b80363e608291ec7df0ccb0b4cf7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gace31b80363e608291ec7df0ccb0b4cf7">linphone_core_set_guess_hostname</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc, bool_t val)</td></tr>
<tr class="memitem:ga1db010bcc9027f1e2aead2e2ddc51eef"><td class="memItemLeft" align="right" valign="top">bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga1db010bcc9027f1e2aead2e2ddc51eef">linphone_core_get_guess_hostname</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
<tr class="memitem:gae1788b49053b46190f7b305d8d21d6af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__linphone__address.html#gaa017e66840f5ee578168bd469b6c3e91">LinphoneAddress</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gae1788b49053b46190f7b305d8d21d6af">linphone_core_get_primary_contact_parsed</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
<tr class="memitem:ga33972bf5275874d28cf0eb59f1d34d18"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga33972bf5275874d28cf0eb59f1d34d18">linphone_core_get_identity</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
<tr class="memitem:gae79c79371d71750ee987757d59785ed7"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gae79c79371d71750ee987757d59785ed7">linphone_registration_state_to_string</a> (<a class="el" href="group__proxies.html#ga698cb4228fac724b9e7c3cc5f499f7a8">LinphoneRegistrationState</a> cs)</td></tr>
<tr class="memitem:gaaedcf1a592cedba55ad05167abd2d7ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaaedcf1a592cedba55ad05167abd2d7ce">linphone_proxy_config_new</a> (void)</td></tr>
<tr class="memitem:ga147377ddae32abf4d3b3777cf0120aed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga147377ddae32abf4d3b3777cf0120aed">linphone_proxy_config_set_server_addr</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj, const char *server_addr)</td></tr>
<tr class="memitem:gaf18076ceb04bc4e779c6e1096e2ef412"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaf18076ceb04bc4e779c6e1096e2ef412">linphone_proxy_config_set_identity</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj, const char *identity)</td></tr>
<tr class="memitem:ga38de87f4addfcddafd50ba8ffcf99d5f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga38de87f4addfcddafd50ba8ffcf99d5f">linphone_proxy_config_set_route</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj, const char *route)</td></tr>
<tr class="memitem:ga9fe1afeb1c29af86b9322e4e900a05a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga9fe1afeb1c29af86b9322e4e900a05a0">linphone_proxy_config_expires</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj, int expires)</td></tr>
<tr class="memitem:gadca1a0fe47bceff0e58d7057672519b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gadca1a0fe47bceff0e58d7057672519b6">linphone_proxy_config_enable_register</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj, bool_t val)</td></tr>
<tr class="memitem:ga37cac414aba9e8e4135c1f208c0175f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga37cac414aba9e8e4135c1f208c0175f8">linphone_proxy_config_edit</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:ga9b59d963af64ee243dfa4643a85c0cdc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga9b59d963af64ee243dfa4643a85c0cdc">linphone_proxy_config_done</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:ga111a1c43aa8aac3b2b95274b5a02be64"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga111a1c43aa8aac3b2b95274b5a02be64">linphone_proxy_config_enable_publish</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj, bool_t val)</td></tr>
<tr class="memitem:gadf8ce7a15604a3b8469e7149f992d916"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gadf8ce7a15604a3b8469e7149f992d916">linphone_proxy_config_set_dial_escape_plus</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg, bool_t val)</td></tr>
<tr class="memitem:ga34cc952a4053bd82f65f8de965e239dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga34cc952a4053bd82f65f8de965e239dc">linphone_proxy_config_set_dial_prefix</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg, const char *prefix)</td></tr>
<tr class="memitem:gaed2155106b24f7e418b67c2774b6a0c7"><td class="memItemLeft" align="right" valign="top">bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaed2155106b24f7e418b67c2774b6a0c7">linphone_proxy_config_is_registered</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:ga86aab63aeafc9313276b099d1b75d028"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga86aab63aeafc9313276b099d1b75d028">linphone_proxy_config_get_route</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:gafebbeb5de42c1cfac8f134714111f10e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gafebbeb5de42c1cfac8f134714111f10e">linphone_proxy_config_get_identity</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:gabac8c9c35d934ff9dfdf0fabae1bcbf2"><td class="memItemLeft" align="right" valign="top">bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gabac8c9c35d934ff9dfdf0fabae1bcbf2">linphone_proxy_config_publish_enabled</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:ga5e1459a6d25b45345525b4eca12d9252"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga5e1459a6d25b45345525b4eca12d9252">linphone_proxy_config_get_addr</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:ga06bc12ed3f1048ee8e93e797fc5aa23e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga06bc12ed3f1048ee8e93e797fc5aa23e">linphone_proxy_config_get_expires</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:gae9a9f097eda6371c7af0fa9760b62686"><td class="memItemLeft" align="right" valign="top">bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gae9a9f097eda6371c7af0fa9760b62686">linphone_proxy_config_register_enabled</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:gaa25934d6fe1edbe0dde366d9a3487247"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaa25934d6fe1edbe0dde366d9a3487247">linphone_proxy_config_refresh_register</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *obj)</td></tr>
<tr class="memitem:ga5f7d7b51c71f544c40e76a64bd81da04"><td class="memItemLeft" align="right" valign="top">bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga5f7d7b51c71f544c40e76a64bd81da04">linphone_proxy_config_get_dial_escape_plus</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg)</td></tr>
<tr class="memitem:ga3df8c8bbe169364504a7e4b7c39c75c3"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga3df8c8bbe169364504a7e4b7c39c75c3">linphone_proxy_config_get_dial_prefix</a> (const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg)</td></tr>
<tr class="memitem:ga4439fde3e342d6dff849904348fa0a49"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga4439fde3e342d6dff849904348fa0a49">linphone_proxy_config_destroy</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg)</td></tr>
<tr class="memitem:gaf404e29bc13306b3e6c4f61f6f4daaec"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaf404e29bc13306b3e6c4f61f6f4daaec">linphone_proxy_config_normalize_number</a> (<a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *proxy, const char *username, char *result, size_t result_len)</td></tr>
<tr class="memitem:ga130795ea67730f7b01f7b51fe6bdb44f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga130795ea67730f7b01f7b51fe6bdb44f">linphone_core_refresh_registers</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
<tr class="memitem:gaccdcbca377b771625aeea9c251b597c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaccdcbca377b771625aeea9c251b597c7">linphone_core_add_proxy_config</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc, <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg)</td></tr>
<tr class="memitem:gaa29f31211db5b4320eba0d215030639b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gaa29f31211db5b4320eba0d215030639b">linphone_core_remove_proxy_config</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc, <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg)</td></tr>
<tr class="memitem:ga3a9d4801bf073c349fe4f4de65aba432"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga3a9d4801bf073c349fe4f4de65aba432">linphone_core_clear_proxy_config</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
<tr class="memitem:ga466cfc7b5f7a63e1efb77732ac3b6de2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#ga466cfc7b5f7a63e1efb77732ac3b6de2">linphone_core_set_default_proxy</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc, <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *config)</td></tr>
<tr class="memitem:gac77d836d546848289f16716cb2db12f6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gac77d836d546848289f16716cb2db12f6">linphone_core_get_default_proxy</a> (<a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc, <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> **config)</td></tr>
<tr class="memitem:gad167a93dd8d6b6fa9b9d36c9ce7cc3fc"><td class="memItemLeft" align="right" valign="top">const MSList * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proxies.html#gad167a93dd8d6b6fa9b9d36c9ce7cc3fc">linphone_core_get_proxy_config_list</a> (const <a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> *lc)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<p>*User registration is controled by <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> settings.<br/>
Each <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> object can be configured with registration informations *like <a class="el" href="group__proxies.html#ga147377ddae32abf4d3b3777cf0120aed">proxy address </a> , <a class="el" href="group__proxies.html#gaf18076ceb04bc4e779c6e1096e2ef412">user id </a>, <a class="el" href="group__proxies.html#ga9fe1afeb1c29af86b9322e4e900a05a0">refresh period </a>, and so on. <br/>
A created proxy config using <a class="el" href="group__proxies.html#gaaedcf1a592cedba55ad05167abd2d7ce">linphone_proxy_config_new()</a>, once configured, must be added to <a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> using function <a class="el" href="group__proxies.html#gaccdcbca377b771625aeea9c251b597c7">linphone_core_add_proxy_config()</a>. <br/>
It is recommended to set a default <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">proxy config </a> using function <a class="el" href="group__proxies.html#ga466cfc7b5f7a63e1efb77732ac3b6de2">linphone_core_set_default_proxy()</a>. Once done, if <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">a proxy config </a> has been configured with attribute <a class="el" href="group__proxies.html#gadca1a0fe47bceff0e58d7057672519b6">enable register </a> , next call to <a class="el" href="group__initializing.html#ga7bdac8ac386483fc4e0876e4c5d13755">linphone_core_iterate()</a> triggers a SIP register. <br/>
Registration status is reported by <a class="el" href="group__initializing.html#gae2118ee5fdce307bd608a2d40bfa3829">LinphoneRegistrationStateCb</a>. <br/>
<br/>
This pseudo code demonstrates basic registration operations: <br/>
</p>
<div class="fragment"><div class="line"><a class="code" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a>* proxy_cfg;</div>
<div class="line"><span class="comment">/*create proxy config*/</span></div>
<div class="line">proxy_cfg = <a class="code" href="group__proxies.html#gaaedcf1a592cedba55ad05167abd2d7ce">linphone_proxy_config_new</a>();</div>
<div class="line"><span class="comment">/*parse identity*/</span></div>
<div class="line"><a class="code" href="group__linphone__address.html#gaa017e66840f5ee578168bd469b6c3e91">LinphoneAddress</a> *from = <a class="code" href="group__linphone__address.html#ga301c9884c0bc8b1050fe790d424e0b49">linphone_address_new</a>(<span class="stringliteral">"sip:toto@sip.titi.com"</span>);</div>
<div class="line"><a class="code" href="group__authentication.html#ga0f8289c1aab407992864a68869107f4f">LinphoneAuthInfo</a> *info;</div>
<div class="line"><span class="keywordflow">if</span> (password!=NULL){</div>
<div class="line"> info=<a class="code" href="group__authentication.html#gada5caa494ea0c9320b42be28a69bea1b">linphone_auth_info_new</a>(<a class="code" href="group__linphone__address.html#ga4fa5a4927c1d2f3a6b7c6824e35a87bf">linphone_address_get_username</a>(from),NULL,<span class="stringliteral">"secret"</span>,NULL,NULL); <span class="comment">/*create authentication structure from identity*/</span></div>
<div class="line"> <a class="code" href="group__authentication.html#ga62ac5bb34f0342f7edc733c42473b7aa">linphone_core_add_auth_info</a>(lc,info); <span class="comment">/*add authentication info to LinphoneCore*/</span></div>
<div class="line">} </div>
<div class="line"><span class="comment">// configure proxy entries</span></div>
<div class="line"><a class="code" href="group__proxies.html#gaf18076ceb04bc4e779c6e1096e2ef412">linphone_proxy_config_set_identity</a>(proxy_cfg,identity); <span class="comment">/*set identity with user name and domain*/</span></div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span>* server_addr = <a class="code" href="group__linphone__address.html#ga95a356f26c67ed4ee88db878b617c65f">linphone_address_get_domain</a>(from); <span class="comment">/*extract domain address from identity*/</span></div>
<div class="line"><a class="code" href="group__proxies.html#ga147377ddae32abf4d3b3777cf0120aed">linphone_proxy_config_set_server_addr</a>(proxy_cfg,server_addr); <span class="comment">/* we assume domain = proxy server address*/</span></div>
<div class="line"><a class="code" href="group__proxies.html#gadca1a0fe47bceff0e58d7057672519b6">linphone_proxy_config_enable_register</a>(proxy_cfg,TRUE); <span class="comment">/*activate registration for this proxy config*/</span></div>
<div class="line"><a class="code" href="group__linphone__address.html#ga5777f2976c71a48cf2b3f03c61818f13">linphone_address_destroy</a>(from); <span class="comment">/*release resource*/</span></div>
<div class="line"></div>
<div class="line"><a class="code" href="group__proxies.html#gaccdcbca377b771625aeea9c251b597c7">linphone_core_add_proxy_config</a>(lc,proxy_cfg); <span class="comment">/*add proxy config to linphone core*/</span></div>
<div class="line"><a class="code" href="group__proxies.html#ga466cfc7b5f7a63e1efb77732ac3b6de2">linphone_core_set_default_proxy</a>(lc,proxy_cfg); <span class="comment">/*set to default proxy*/</span> </div>
</div><!-- fragment --><p> <br/>
Registration sate call back: </p>
<div class="fragment"><div class="line"> <span class="keyword">static</span> <span class="keywordtype">void</span> registration_state_changed(<span class="keyword">struct</span> _LinphoneCore *lc, <a class="code" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> *cfg, <a class="code" href="group__proxies.html#ga698cb4228fac724b9e7c3cc5f499f7a8">LinphoneRegistrationState</a> cstate, <span class="keyword">const</span> <span class="keywordtype">char</span> *message){</div>
<div class="line"> printf(<span class="stringliteral">"New registration state %s for user id [%s] at proxy [%s]\n"</span></div>
<div class="line"> ,<a class="code" href="group__proxies.html#gae79c79371d71750ee987757d59785ed7">linphone_registration_state_to_string</a>(cstate)</div>
<div class="line"> ,<a class="code" href="group__proxies.html#gafebbeb5de42c1cfac8f134714111f10e">linphone_proxy_config_get_identity</a>(cfg)</div>
<div class="line"> ,<a class="code" href="group__proxies.html#ga5e1459a6d25b45345525b4eca12d9252">linphone_proxy_config_get_addr</a>(cfg));</div>
<div class="line">}</div>
</div><!-- fragment --><p> <br/>
<b>Authentication:</b> <br/>
Most of the time, registration requires <a class="el" href="group__authentication.html">authentication</a> to succed. <a class="el" href="group__authentication.html#ga0f8289c1aab407992864a68869107f4f">LinphoneAuthInfo</a> info must be either added to <a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> using function <a class="el" href="group__authentication.html#ga62ac5bb34f0342f7edc733c42473b7aa">linphone_core_add_auth_info()</a> before <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> is added to Linphone core, or on demand from call back <a class="el" href="group__initializing.html#ga2673e7baaa3ddec6190902fc76204b29">AuthInfoRequested</a> . <br/>
<br/>
<b>Unregistration:</b> <br/>
Unregistration or any changes to <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> must be first started by a call to function <a class="el" href="group__proxies.html#ga37cac414aba9e8e4135c1f208c0175f8">linphone_proxy_config_edit()</a> and validated by function <a class="el" href="group__proxies.html#ga9b59d963af64ee243dfa4643a85c0cdc">linphone_proxy_config_done()</a> <br/>
This pseudo code shows how to unregister a user associated to a <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> </p>
<div class="fragment"><div class="line"><a class="code" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a>* proxy_cfg;</div>
<div class="line"><a class="code" href="group__proxies.html#gac77d836d546848289f16716cb2db12f6">linphone_core_get_default_proxy</a>(lc,&proxy_cfg); <span class="comment">/* get default proxy config*/</span></div>
<div class="line"><a class="code" href="group__proxies.html#ga37cac414aba9e8e4135c1f208c0175f8">linphone_proxy_config_edit</a>(proxy_cfg); <span class="comment">/*start editing proxy configuration*/</span></div>
<div class="line"><a class="code" href="group__proxies.html#gadca1a0fe47bceff0e58d7057672519b6">linphone_proxy_config_enable_register</a>(proxy_cfg,FALSE); <span class="comment">/*de-activate registration for this proxy config*/</span></div>
<div class="line"><a class="code" href="group__proxies.html#ga9b59d963af64ee243dfa4643a85c0cdc">linphone_proxy_config_done</a>(proxy_cfg); <span class="comment">/*initiate REGISTER with expire = 0*/</span></div>
</div><!-- fragment --><p> <br/>
A complete tutorial can be found at : <a class="el" href="group__registration__tutorials.html">Registration tutorial</a> </p>
<h2>Typedef Documentation</h2>
<a class="anchor" id="ga1879a0d59e068457b688138da97f2d0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _LinphoneProxyConfig <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The LinphoneProxyConfig object represents a proxy configuration to be used by the LinphoneCore object. Its fields must not be used directly in favour of the accessors methods. Once created and filled properly the LinphoneProxyConfig can be given to LinphoneCore with <a class="el" href="group__proxies.html#gaccdcbca377b771625aeea9c251b597c7">linphone_core_add_proxy_config()</a>. This will automatically triggers the registration, if enabled.</p>
<p>The proxy configuration are persistent to restarts because they are saved in the configuration file. As a consequence, after <a class="el" href="group__initializing.html#gac93ed982ae84a5a282a703c8433ca42f">linphone_core_new()</a> there might already be a list of configured proxy that can be examined with <a class="el" href="group__proxies.html#gad167a93dd8d6b6fa9b9d36c9ce7cc3fc">linphone_core_get_proxy_config_list()</a>.</p>
<p>The default proxy (see <a class="el" href="group__proxies.html#ga466cfc7b5f7a63e1efb77732ac3b6de2">linphone_core_set_default_proxy()</a> ) is the one of the list that is used by default for calls. </p>
</div>
</div>
<a class="anchor" id="ga698cb4228fac724b9e7c3cc5f499f7a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__proxies.html#gaea1b64a739b1faf0b490fe0f52cfe65e">_LinphoneRegistrationState</a> <a class="el" href="group__proxies.html#ga698cb4228fac724b9e7c3cc5f499f7a8">LinphoneRegistrationState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>LinphoneRegistrationState describes proxy registration states. </p>
</div>
</div>
<h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gaea1b64a739b1faf0b490fe0f52cfe65e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__proxies.html#gaea1b64a739b1faf0b490fe0f52cfe65e">_LinphoneRegistrationState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>LinphoneRegistrationState describes proxy registration states. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaea1b64a739b1faf0b490fe0f52cfe65ea07341285f0270fe6e3b1e21949725d54"></a>LinphoneRegistrationNone</em> </td><td>
<p>Initial state for registrations </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaea1b64a739b1faf0b490fe0f52cfe65eae20dab1677f285ef32006cc86f8ea630"></a>LinphoneRegistrationProgress</em> </td><td>
<p>Registration is in progress </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaea1b64a739b1faf0b490fe0f52cfe65ea73e009ef868a552c580b179578b87366"></a>LinphoneRegistrationOk</em> </td><td>
<p>Registration is successful </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaea1b64a739b1faf0b490fe0f52cfe65eaf08a66584f81f4bbc9bfd1e3166c348d"></a>LinphoneRegistrationCleared</em> </td><td>
<p>Unregistration succeeded </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaea1b64a739b1faf0b490fe0f52cfe65eaa9861e7fe94dd55d5e9f7e58119abe5d"></a>LinphoneRegistrationFailed</em> </td><td>
<p>Registration failed </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2>Function Documentation</h2>
<a class="anchor" id="ga8ff876ddd266a66e315fe0576537fb77"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_core_set_primary_contact </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>contact</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the local "from" identity.</p>
<p>This data is used in absence of any proxy configuration or when no default proxy configuration is set. See LinphoneProxyConfig </p>
</div>
</div>
<a class="anchor" id="ga147c072e33bdf5d44a3b95b28b4b27a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* linphone_core_get_primary_contact </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the default identity when no proxy configuration is used. </p>
</div>
</div>
<a class="anchor" id="gace31b80363e608291ec7df0ccb0b4cf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_set_guess_hostname </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool_t </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells LinphoneCore to guess local hostname automatically in primary contact. </p>
</div>
</div>
<a class="anchor" id="ga1db010bcc9027f1e2aead2e2ddc51eef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool_t linphone_core_get_guess_hostname </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns TRUE if hostname part of primary contact is guessed automatically. </p>
</div>
</div>
<a class="anchor" id="gae1788b49053b46190f7b305d8d21d6af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__linphone__address.html#gaa017e66840f5ee578168bd469b6c3e91">LinphoneAddress</a>* linphone_core_get_primary_contact_parsed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as <a class="el" href="group__proxies.html#ga147c072e33bdf5d44a3b95b28b4b27a1">linphone_core_get_primary_contact()</a> but the result is a LinphoneAddress object instead of const char* </p>
</div>
</div>
<a class="anchor" id="ga33972bf5275874d28cf0eb59f1d34d18"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * linphone_core_get_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the default identity SIP address.</p>
<p>This is an helper function:</p>
<p>If no default proxy is set, this will return the primary contact ( see <a class="el" href="group__proxies.html#ga147c072e33bdf5d44a3b95b28b4b27a1">linphone_core_get_primary_contact()</a> ). If a default proxy is set it returns the registered identity on the proxy. </p>
</div>
</div>
<a class="anchor" id="gae79c79371d71750ee987757d59785ed7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* linphone_registration_state_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga698cb4228fac724b9e7c3cc5f499f7a8">LinphoneRegistrationState</a> </td>
<td class="paramname"><em>cs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Human readable version of the <a class="el" href="group__proxies.html#ga698cb4228fac724b9e7c3cc5f499f7a8">LinphoneRegistrationState</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cs</td><td>sate </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaaedcf1a592cedba55ad05167abd2d7ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * linphone_proxy_config_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty proxy config. </p>
</div>
</div>
<a class="anchor" id="ga147377ddae32abf4d3b3777cf0120aed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_proxy_config_set_server_addr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>server_addr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the proxy address</p>
<p>Examples of valid sip proxy address are:</p>
<ul>
<li>IP address: sip:87.98.157.38</li>
<li>IP address with port: sip:87.98.157.38:5062</li>
<li>hostnames : sip:sip.example.net </li>
</ul>
</div>
</div>
<a class="anchor" id="gaf18076ceb04bc4e779c6e1096e2ef412"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_proxy_config_set_identity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>identity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the user identity as a SIP address.</p>
<p>This identity is normally formed with display name, username and domain, such as: Alice <sip:<a href="#" onclick="location.href='mai'+'lto:'+'ali'+'ce'+'@ex'+'am'+'ple'+'.n'+'et'; return false;">alice<span style="display: none;">.nosp@m.</span>@exa<span style="display: none;">.nosp@m.</span>mple.<span style="display: none;">.nosp@m.</span>net</a>> The REGISTER messages will have from and to set to this identity. </p>
</div>
</div>
<a class="anchor" id="ga38de87f4addfcddafd50ba8ffcf99d5f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_proxy_config_set_route </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>route</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a SIP route. When a route is set, all outgoing calls will go to the route's destination if this proxy is the default one (see <a class="el" href="group__proxies.html#ga466cfc7b5f7a63e1efb77732ac3b6de2">linphone_core_set_default_proxy()</a> ). </p>
</div>
</div>
<a class="anchor" id="ga9fe1afeb1c29af86b9322e4e900a05a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_expires </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the registration expiration time in seconds. </p>
</div>
</div>
<a class="anchor" id="gadca1a0fe47bceff0e58d7057672519b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_enable_register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool_t </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates either or not, REGISTRATION must be issued for this <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> . <br/>
In case this <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> has been added to <a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a>, follows the <a class="el" href="group__proxies.html#ga37cac414aba9e8e4135c1f208c0175f8">linphone_proxy_config_edit()</a> rule. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>object pointer </td></tr>
<tr><td class="paramname">val</td><td>if true, registration will be engaged</td></tr>
</table>
</dd>
</dl>
<p>Indicates whether a REGISTER request must be sent to the proxy. </p>
</div>
</div>
<a class="anchor" id="ga37cac414aba9e8e4135c1f208c0175f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_edit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts editing a proxy configuration.</p>
<p>Because proxy configuration must be consistent, applications MUST call <a class="el" href="group__proxies.html#ga37cac414aba9e8e4135c1f208c0175f8">linphone_proxy_config_edit()</a> before doing any attempts to modify proxy configuration (such as identity, proxy address and so on). Once the modifications are done, then the application must call <a class="el" href="group__proxies.html#ga9b59d963af64ee243dfa4643a85c0cdc">linphone_proxy_config_done()</a> to commit the changes. </p>
</div>
</div>
<a class="anchor" id="ga9b59d963af64ee243dfa4643a85c0cdc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_proxy_config_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commits modification made to the proxy configuration. </p>
</div>
</div>
<a class="anchor" id="ga111a1c43aa8aac3b2b95274b5a02be64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_enable_publish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool_t </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates either or not, PUBLISH must be issued for this <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> . <br/>
In case this <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> has been added to <a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a>, follows the <a class="el" href="group__proxies.html#ga37cac414aba9e8e4135c1f208c0175f8">linphone_proxy_config_edit()</a> rule. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>object pointer </td></tr>
<tr><td class="paramname">val</td><td>if true, publish will be engaged </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gadf8ce7a15604a3b8469e7149f992d916"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_set_dial_escape_plus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool_t </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether liblinphone should replace "+" by "00" in dialed numbers (passed to <a class="el" href="group__call__control.html#gaaea662739cc3825eaa80d8ac264a883c">linphone_core_invite</a> ). </p>
</div>
</div>
<a class="anchor" id="ga34cc952a4053bd82f65f8de965e239dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_set_dial_prefix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>prefix</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a dialing prefix to be automatically prepended when inviting a number with <a class="el" href="group__call__control.html#gaaea662739cc3825eaa80d8ac264a883c">linphone_core_invite</a>. </p>
</div>
</div>
<a class="anchor" id="gaed2155106b24f7e418b67c2774b6a0c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool_t linphone_proxy_config_is_registered </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a boolean indicating that the user is sucessfully registered on the proxy. </p>
</div>
</div>
<a class="anchor" id="ga86aab63aeafc9313276b099d1b75d028"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * linphone_proxy_config_get_route </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the route set for this proxy configuration. </p>
</div>
</div>
<a class="anchor" id="gafebbeb5de42c1cfac8f134714111f10e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * linphone_proxy_config_get_identity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the SIP identity that belongs to this proxy configuration.</p>
<p>The SIP identity is a SIP address (Display Name <sip:username> ) </p>
</div>
</div>
<a class="anchor" id="gabac8c9c35d934ff9dfdf0fabae1bcbf2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool_t linphone_proxy_config_publish_enabled </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns TRUE if PUBLISH request is enabled for this proxy. </p>
</div>
</div>
<a class="anchor" id="ga5e1459a6d25b45345525b4eca12d9252"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * linphone_proxy_config_get_addr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the proxy's SIP address. </p>
</div>
</div>
<a class="anchor" id="ga06bc12ed3f1048ee8e93e797fc5aa23e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_proxy_config_get_expires </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the duration of registration. </p>
</div>
</div>
<a class="anchor" id="gae9a9f097eda6371c7af0fa9760b62686"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool_t linphone_proxy_config_register_enabled </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns TRUE if registration to the proxy is enabled. </p>
</div>
</div>
<a class="anchor" id="gaa25934d6fe1edbe0dde366d9a3487247"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_refresh_register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Refresh a proxy registration. This is useful if for example you resuming from suspend, thus IP address may have changed. </p>
</div>
</div>
<a class="anchor" id="ga5f7d7b51c71f544c40e76a64bd81da04"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool_t linphone_proxy_config_get_dial_escape_plus </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether liblinphone should replace "+" by "00" in dialed numbers (passed to <a class="el" href="group__call__control.html#gaaea662739cc3825eaa80d8ac264a883c">linphone_core_invite</a> ). </p>
</div>
</div>
<a class="anchor" id="ga3df8c8bbe169364504a7e4b7c39c75c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * linphone_proxy_config_get_dial_prefix </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns dialing prefix. </p>
</div>
</div>
<a class="anchor" id="ga4439fde3e342d6dff849904348fa0a49"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_proxy_config_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a proxy config.</p>
<dl class="section note"><dt>Note</dt><dd>: LinphoneProxyConfig that have been removed from LinphoneCore with <a class="el" href="group__proxies.html#gaa29f31211db5b4320eba0d215030639b">linphone_core_remove_proxy_config()</a> must not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="gaf404e29bc13306b3e6c4f61f6f4daaec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_proxy_config_normalize_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>proxy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>result_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222 </p>
</div>
</div>
<a class="anchor" id="ga130795ea67730f7b01f7b51fe6bdb44f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_refresh_registers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>force registration refresh to be initiated upon next iterate </p>
</div>
</div>
<a class="anchor" id="gaccdcbca377b771625aeea9c251b597c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_core_add_proxy_config </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>cfg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a proxy configuration. This will start registration on the proxy, if registration is enabled. </p>
</div>
</div>
<a class="anchor" id="gaa29f31211db5b4320eba0d215030639b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_remove_proxy_config </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>cfg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a proxy configuration.</p>
<p>LinphoneCore will then automatically unregister and place the proxy configuration on a deleted list. For that reason, a removed proxy does NOT need to be freed. </p>
</div>
</div>
<a class="anchor" id="ga3a9d4801bf073c349fe4f4de65aba432"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_clear_proxy_config </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Erase all proxies from config. </p>
</div>
</div>
<a class="anchor" id="ga466cfc7b5f7a63e1efb77732ac3b6de2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linphone_core_set_default_proxy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> * </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the default proxy.</p>
<p>This default proxy must be part of the list of already entered LinphoneProxyConfig. Toggling it as default will make LinphoneCore use the identity associated with the proxy configuration in all incoming and outgoing calls. </p>
</div>
</div>
<a class="anchor" id="gac77d836d546848289f16716cb2db12f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linphone_core_get_default_proxy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__proxies.html#ga1879a0d59e068457b688138da97f2d0b">LinphoneProxyConfig</a> ** </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the default proxy configuration, that is the one used to determine the current identity. </p>
</div>
</div>
<a class="anchor" id="gad167a93dd8d6b6fa9b9d36c9ce7cc3fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const MSList* linphone_core_get_proxy_config_list </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__initializing.html#gaa5cf635b82dd338e7ee2dd3599d05f0a">LinphoneCore</a> * </td>
<td class="paramname"><em>lc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an unmodifiable list of entered proxy configurations. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
