BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJSIP Reference

AccountIpChangeConfig Struct Reference

#include <account.hpp>

Public Member Functions

virtual ~AccountIpChangeConfig ()
 
virtual void readObject (const ContainerNode &node) throw (Error)
 
virtual void writeObject (ContainerNode &node) const throw (Error)
 

Data Fields

bool shutdownTp
 
bool hangupCalls
 
unsigned reinviteFlags
 
unsigned reinvUseUpdate
 

Detailed Description

Account config specific to IP address change.

Constructor & Destructor Documentation

◆ ~AccountIpChangeConfig()

virtual AccountIpChangeConfig::~AccountIpChangeConfig ( )
inlinevirtual

Virtual destructor

Member Function Documentation

◆ readObject()

virtual void AccountIpChangeConfig::readObject ( const ContainerNode &  node)
throw (Error
)
virtual

Read this object from a container node.

Parameters
nodeContainer to read values from.

◆ writeObject()

virtual void AccountIpChangeConfig::writeObject ( ContainerNode &  node) const
throw (Error
)
virtual

Write this object to a container node.

Parameters
nodeContainer to write values to.

Field Documentation

◆ shutdownTp

bool AccountIpChangeConfig::shutdownTp

Shutdown the transport used for account registration. If this is set to PJ_TRUE, the transport will be shutdown altough it's used by multiple account. Shutdown transport will be followed by re-Registration if AccountConfig.natConfig.contactRewriteUse is enabled.

Default: true

◆ hangupCalls

bool AccountIpChangeConfig::hangupCalls

Hangup active calls associated with the acount. If this is set to true, then the calls will be hang up.

Default: false

◆ reinviteFlags

unsigned AccountIpChangeConfig::reinviteFlags

Specify the call flags used in the re-INVITE when hangupCalls is set to false. If this is set to 0, no re-INVITE will be sent. The re-INVITE will be sent after re-Registration is finished.

Default: PJSUA_CALL_REINIT_MEDIA | PJSUA_CALL_UPDATE_CONTACT | PJSUA_CALL_UPDATE_VIA

◆ reinvUseUpdate

unsigned AccountIpChangeConfig::reinvUseUpdate

For refreshing the call, use SIP UPDATE, instead of re-INVITE, if remote supports it (by publishing it in Allow header). If remote does not support UPDATE method or somehow the UPDATE attempt fails, it will fallback to using re-INVITE. The reinviteFlags will be used regardless whether it is re-INVITE or UPDATE that is sent.

Default: PJ_FALSE (using re-INVITE).


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.