BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

pj::AccountSipConfig Struct Reference

#include <account.hpp>

Inheritance diagram for pj::AccountSipConfig:
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

AuthCredInfoVector authCreds
 
StringVector proxies
 
string contactForced
 
string contactParams
 
string contactUriParams
 
bool authInitialEmpty
 
string authInitialAlgorithm
 
TransportId transportId
 

Detailed Description

Various SIP settings for the account. This will be specified in AccountConfig.

Member Function Documentation

◆ readObject()

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

Read this object from a container node.

Parameters
nodeContainer to read values from.

Implements pj::PersistentObject.

◆ writeObject()

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

Write this object to a container node.

Parameters
nodeContainer to write values to.

Implements pj::PersistentObject.

Field Documentation

◆ authCreds

AuthCredInfoVector pj::AccountSipConfig::authCreds

Array of credentials. If registration is desired, normally there should be at least one credential specified, to successfully authenticate against the service provider. More credentials can be specified, for example when the requests are expected to be challenged by the proxies in the route set.

◆ proxies

StringVector pj::AccountSipConfig::proxies

Array of proxy servers to visit for outgoing requests. Each of the entry is translated into one Route URI.

◆ contactForced

string pj::AccountSipConfig::contactForced

Optional URI to be put as Contact for this account. It is recommended that this field is left empty, so that the value will be calculated automatically based on the transport address.

◆ contactParams

string pj::AccountSipConfig::contactParams

Additional parameters that will be appended in the Contact header for this account. This will affect the Contact header in all SIP messages sent on behalf of this account, including but not limited to REGISTER, INVITE, and SUBCRIBE requests or responses.

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::AccountSipConfig::contactUriParams

Additional URI parameters that will be appended in the Contact URI for this account. This will affect the Contact URI in all SIP messages sent on behalf of this account, including but not limited to REGISTER, INVITE, and SUBCRIBE requests or responses.

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

◆ authInitialEmpty

bool pj::AccountSipConfig::authInitialEmpty

If this flag is set, the authentication client framework will send an empty Authorization header in each initial request. Default is no.

◆ authInitialAlgorithm

string pj::AccountSipConfig::authInitialAlgorithm

Specify the algorithm to use when empty Authorization header is to be sent for each initial request (see above)

◆ transportId

TransportId pj::AccountSipConfig::transportId

Optionally bind this account to specific transport. This normally is not a good idea, as account should be able to send requests using any available transports according to the destination. But some application may want to have explicit control over the transport to use, so in that case it can set this field.

Default: -1 (PJSUA_INVALID_ID)

See also
Account::setTransport()

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.