Liblinphone: Basic registration

Liblinphone 5.3.0

Basic registration

This program is a very simple usage example of liblinphone.

This program is a very simple usage example of liblinphone.

Desmonstrating how to initiate a SIP registration from a sip uri identity passed from the command line. first argument must be like sip:jehan.nosp@m.@sip.nosp@m..linp.nosp@m.hone.nosp@m..org , second must be password .
ex registration sip:jehan.nosp@m.@sip.nosp@m..linp.nosp@m.hone.nosp@m..org secret
Registration is cleared on SIGINT

/*
* Copyright (c) 2010-2022 Belledonne Communications SARL.
*
* This file is part of Liblinphone
* (see https://gitlab.linphone.org/BC/public/liblinphone).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "linphone/core.h"
#include <signal.h>
static bool_t running = TRUE;
static void stop(int signum) {
running = FALSE;
}
static void registration_state_changed(struct _LinphoneCore *lc,
LinphoneProxyConfig *cfg,
LinphoneRegistrationState cstate,
const char *message) {
printf("New registration state %s for user id [%s] at proxy [%s]\n", linphone_registration_state_to_string(cstate),
linphone_proxy_config_get_identity(cfg), linphone_proxy_config_get_addr(cfg));
}
LinphoneCore *lc;
int main(int argc, char *argv[]) {
LinphoneCoreVTable vtable = {0};
LinphoneProxyConfig *proxy_cfg;
LinphoneAddress *from;
LinphoneAuthInfo *info;
char *identity = NULL;
char *password = NULL;
const char *server_addr;
/* takes sip uri identity from the command line arguments */
if (argc > 1) {
identity = argv[1];
}
/* takes password from the command line arguments */
if (argc > 2) {
password = argv[2];
}
signal(SIGINT, stop);
#ifdef DEBUG_LOGS
linphone_core_enable_logs(NULL); /*enable liblinphone logs.*/
#endif
/*
Fill the LinphoneCoreVTable with application callbacks.
All are optional. Here we only use the registration_state_changed callbacks
in order to get notifications about the progress of the registration.
*/
vtable.registration_state_changed = registration_state_changed;
/*
Instanciate a LinphoneCore object given the LinphoneCoreVTable
*/
lc = linphone_core_new(&vtable, NULL, NULL, NULL);
/*create proxy config*/
proxy_cfg = linphone_core_create_proxy_config(lc);
/*parse identity*/
from = linphone_address_new(identity);
if (from == NULL) {
printf("%s not a valid sip uri, must be like sip:toto@sip.linphone.org \n", identity);
goto end;
}
if (password != NULL) {
info = linphone_auth_info_new(linphone_address_get_username(from), NULL, password, NULL, NULL,
NULL); /*create authentication structure from identity*/
linphone_core_add_auth_info(lc, info); /*add authentication info to LinphoneCore*/
}
// configure proxy entries
linphone_proxy_config_set_identity_address(proxy_cfg, from); /*set identity with user name and domain*/
server_addr = linphone_address_get_domain(from); /*extract domain address from identity*/
linphone_proxy_config_set_server_addr(proxy_cfg, server_addr); /* we assume domain = proxy server address*/
linphone_proxy_config_enable_register(proxy_cfg, TRUE); /*activate registration for this proxy config*/
linphone_address_unref(from); /*release resource*/
linphone_core_add_proxy_config(lc, proxy_cfg); /*add proxy config to linphone core*/
linphone_core_set_default_proxy_config(lc, proxy_cfg); /*set to default proxy*/
/* main loop for receiving notifications and doing background linphonecore work: */
while (running) {
linphone_core_iterate(lc); /* first iterate initiates registration */
ms_usleep(50000);
}
proxy_cfg = linphone_core_get_default_proxy_config(lc); /* get default proxy config*/
linphone_proxy_config_edit(proxy_cfg); /*start editing proxy configuration*/
linphone_proxy_config_enable_register(proxy_cfg, FALSE); /*de-activate registration for this proxy config*/
linphone_proxy_config_done(proxy_cfg); /*initiate REGISTER with expire = 0*/
while (linphone_proxy_config_get_state(proxy_cfg) != LinphoneRegistrationCleared) {
linphone_core_iterate(lc); /*to make sure we receive call backs before shutting down*/
ms_usleep(50000);
}
end:
printf("Shutting down...\n");
linphone_core_destroy(lc);
printf("Exited\n");
return 0;
}
linphone_auth_info_new
LinphoneAuthInfo * linphone_auth_info_new(const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm, const char *domain)
Safely cast a belle_sip_object_t into LinphoneAuthInfo.
linphone_core_add_auth_info
void linphone_core_add_auth_info(LinphoneCore *core, const LinphoneAuthInfo *info)
Adds authentication information to the LinphoneCore.
LinphoneAuthInfo
struct _LinphoneAuthInfo LinphoneAuthInfo
Object holding authentication information.
Definition c-types.h:84
linphone_core_iterate
void linphone_core_iterate(LinphoneCore *core)
Main loop function.
linphone_core_new
MS2_DEPRECATED LinphoneCore * linphone_core_new(const LinphoneCoreVTable *vtable, const char *config_path, const char *factory_config_path, void *userdata)
Instanciates a LinphoneCore object.
LinphoneCoreVTable
struct _LinphoneCoreVTable LinphoneCoreVTable
This structure holds all callbacks that the application should implement.
LinphoneCore
struct _LinphoneCore LinphoneCore
Main object to instanciate and on which to keep a reference.
Definition types.h:495
linphone_core_destroy
MS2_DEPRECATED void linphone_core_destroy(LinphoneCore *core)
Destroys a LinphoneCore.
LinphoneAddress
struct _LinphoneAddress LinphoneAddress
Object that represents a parsed SIP address.
Definition c-types.h:131
linphone_address_get_username
const char * linphone_address_get_username(const LinphoneAddress *address)
Returns the username.
linphone_address_new
LinphoneAddress * linphone_address_new(const char *address)
Constructs a LinphoneAddress object by parsing the user supplied address, given as a string.
linphone_address_unref
void linphone_address_unref(LinphoneAddress *address)
Decrement reference count of LinphoneAddress object.
linphone_address_get_domain
const char * linphone_address_get_domain(const LinphoneAddress *address)
Returns the domain name.
linphone_core_create_proxy_config
LinphoneProxyConfig * linphone_core_create_proxy_config(LinphoneCore *core)
Create a proxy config with default values from Linphone core.
LinphoneProxyConfig
struct _LinphoneProxyConfig LinphoneProxyConfig
Represents an account configuration to be used by LinphoneCore.
Definition types.h:54
linphone_proxy_config_done
LinphoneStatus linphone_proxy_config_done(LinphoneProxyConfig *proxy_config)
Commits modification made to the proxy configuration.
linphone_registration_state_to_string
const char * linphone_registration_state_to_string(LinphoneRegistrationState state)
Human readable version of the LinphoneRegistrationState.
linphone_proxy_config_edit
void linphone_proxy_config_edit(LinphoneProxyConfig *proxy_config)
Starts editing a proxy configuration.
linphone_proxy_config_get_state
LinphoneRegistrationState linphone_proxy_config_get_state(const LinphoneProxyConfig *proxy_config)
Get the registration state of the given proxy config.
LinphoneRegistrationState
enum _LinphoneRegistrationState LinphoneRegistrationState
Describes proxy registration states.
linphone_core_get_default_proxy_config
LinphoneProxyConfig * linphone_core_get_default_proxy_config(const LinphoneCore *core)
Returns the default proxy configuration, that is the one used to determine the current identity.
linphone_proxy_config_enable_register
void linphone_proxy_config_enable_register(LinphoneProxyConfig *proxy_config, bool_t enable)
Indicates either or not, REGISTRATION must be issued for this LinphoneProxyConfig.
linphone_core_set_default_proxy_config
void linphone_core_set_default_proxy_config(LinphoneCore *core, LinphoneProxyConfig *config)
Sets the default proxy.
linphone_core_add_proxy_config
LinphoneStatus linphone_core_add_proxy_config(LinphoneCore *core, LinphoneProxyConfig *config)
Add a proxy configuration.
linphone_proxy_config_set_identity_address
LinphoneStatus linphone_proxy_config_set_identity_address(LinphoneProxyConfig *proxy_config, LinphoneAddress *identity)
Sets the user identity as a SIP address.
linphone_proxy_config_get_identity
MS2_DEPRECATED const char * linphone_proxy_config_get_identity(const LinphoneProxyConfig *cfg)
linphone_proxy_config_set_server_addr
LinphoneStatus linphone_proxy_config_set_server_addr(LinphoneProxyConfig *proxy_config, const char *server_address)
Sets the proxy address.
LinphoneRegistrationCleared
@ LinphoneRegistrationCleared
Unregistration succeeded.
Definition types.h:467
_LinphoneCoreVTable::registration_state_changed
LinphoneCoreRegistrationStateChangedCb registration_state_changed
Notifies registration state changes.
Definition core.h:219