BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

pj::AccountRegConfig Struct Reference

#include <account.hpp>

Inheritance diagram for pj::AccountRegConfig:
pj::PersistentObject

Public Member Functions

virtual void readObject (const ContainerNode &node) PJSUA2_THROW(Error)
 
virtual void writeObject (ContainerNode &node) const PJSUA2_THROW(Error)
 
- Public Member Functions inherited from pj::PersistentObject
virtual ~PersistentObject ()
 

Data Fields

string registrarUri
 
bool registerOnAdd
 
SipHeaderVector headers
 
string contactParams
 
string contactUriParams
 
unsigned timeoutSec
 
unsigned retryIntervalSec
 
unsigned firstRetryIntervalSec
 
unsigned randomRetryIntervalSec
 
unsigned delayBeforeRefreshSec
 
bool dropCallsOnFail
 
unsigned unregWaitMsec
 
unsigned proxyUse
 

Detailed Description

Account registration config. This will be specified in AccountConfig.

Member Function Documentation

◆ readObject()

virtual void pj::AccountRegConfig::readObject ( const ContainerNode node)
virtual

◆ writeObject()

virtual void pj::AccountRegConfig::writeObject ( ContainerNode node) const
virtual

Write this object to a container node.

Parameters
nodeContainer to write values to.

Implements pj::PersistentObject.

Field Documentation

◆ registrarUri

string pj::AccountRegConfig::registrarUri

This is the URL to be put in the request URI for the registration, and will look something like "sip:serviceprovider".

This field should be specified if registration is desired. If the value is empty, no account registration will be performed.

◆ registerOnAdd

bool pj::AccountRegConfig::registerOnAdd

Specify whether the account should register as soon as it is added to the UA. Application can set this to PJ_FALSE and control the registration manually with pjsua_acc_set_registration().

Default: True

◆ headers

SipHeaderVector pj::AccountRegConfig::headers

The optional custom SIP headers to be put in the registration request.

◆ contactParams

string pj::AccountRegConfig::contactParams

Additional parameters that will be appended in the Contact header of the registration requests. This will be appended after AccountSipConfig.contactParams;

The parameters should be preceeded by semicolon, and all strings must be properly escaped. Example: ";my-param=X;another-param=Hi%20there"

◆ contactUriParams

string pj::AccountRegConfig::contactUriParams

Additional parameters that will be appended in the Contact URI of the registration requests. This will be appended after AccountSipConfig.contactUriParams;

The parameters should be preceeded by semicolon, and all strings must be properly escaped. Example: ";my-param=X;another-param=Hi%20there"

◆ timeoutSec

unsigned pj::AccountRegConfig::timeoutSec

Optional interval for registration, in seconds. If the value is zero, default interval will be used (PJSUA_REG_INTERVAL, 300 seconds).

◆ retryIntervalSec

unsigned pj::AccountRegConfig::retryIntervalSec

Specify interval of auto registration retry upon registration failure (including caused by transport problem), in second. Set to 0 to disable auto re-registration. Note that if the registration retry occurs because of transport failure, the first retry will be done after firstRetryIntervalSec seconds instead. Also note that the interval will be randomized slightly by some seconds (specified in reg_retry_random_interval) to avoid all clients re-registering at the same time.

See also firstRetryIntervalSec and randomRetryIntervalSec settings.

Default: PJSUA_REG_RETRY_INTERVAL

◆ firstRetryIntervalSec

unsigned pj::AccountRegConfig::firstRetryIntervalSec

This specifies the interval for the first registration retry. The registration retry is explained in retryIntervalSec. Note that the value here will also be randomized by some seconds (specified in reg_retry_random_interval) to avoid all clients re-registering at the same time.

See also retryIntervalSec and randomRetryIntervalSec settings.

Default: 0

◆ randomRetryIntervalSec

unsigned pj::AccountRegConfig::randomRetryIntervalSec

This specifies maximum randomized value to be added/substracted to/from the registration retry interval specified in reg_retry_interval and reg_first_retry_interval, in second. This is useful to avoid all clients re-registering at the same time. For example, if the registration retry interval is set to 100 seconds and this is set to 10 seconds, the actual registration retry interval will be in the range of 90 to 110 seconds.

See also retryIntervalSec and firstRetryIntervalSec settings.

Default: 10

◆ delayBeforeRefreshSec

unsigned pj::AccountRegConfig::delayBeforeRefreshSec

Specify the number of seconds to refresh the client registration before the registration expires.

Default: PJSIP_REGISTER_CLIENT_DELAY_BEFORE_REFRESH, 5 seconds

◆ dropCallsOnFail

bool pj::AccountRegConfig::dropCallsOnFail

Specify whether calls of the configured account should be dropped after registration failure and an attempt of re-registration has also failed.

Default: FALSE (disabled)

◆ unregWaitMsec

unsigned pj::AccountRegConfig::unregWaitMsec

Specify the maximum time to wait for unregistration requests to complete during library shutdown sequence.

Default: PJSUA_UNREG_TIMEOUT

◆ proxyUse

unsigned pj::AccountRegConfig::proxyUse

Specify how the registration uses the outbound and account proxy settings. This controls if and what Route headers will appear in the REGISTER request of this account. The value is bitmask combination of PJSUA_REG_USE_OUTBOUND_PROXY and PJSUA_REG_USE_ACC_PROXY bits. If the value is set to 0, the REGISTER request will not use any proxy (i.e. it will not have any Route headers).

Default: 3 (PJSUA_REG_USE_OUTBOUND_PROXY | PJSUA_REG_USE_ACC_PROXY)


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

 


PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
Copyright (C) 2006-2008 Teluu Inc.