This class extends the resip MasterProfile to include UserAgent specific settings. More...

#include <UserAgentMasterProfile.hxx>

Inheritance diagram for recon::UserAgentMasterProfile:

Classes
class	TransportInfo

Public Member Functions
	UserAgentMasterProfile ()

void	setTransportSipMessageLoggingHandler (std::shared_ptr< resip::Transport::SipMessageLoggingHandler > handler) noexcept

std::shared_ptr< resip::Transport::SipMessageLoggingHandler >	getTransportSipMessageLoggingHandler () const noexcept

void	setRTCPEventLoggingHandler (std::shared_ptr< flowmanager::RTCPEventLoggingHandler > handler) noexcept

std::shared_ptr< flowmanager::RTCPEventLoggingHandler >	getRTCPEventLoggingHandler () const noexcept

virtual bool &	dtmfDigitLoggingEnabled ()
	Get/Set wether recon is allowed to log DTMF digits pressed.

virtual const bool	dtmfDigitLoggingEnabled () const

void	addTransport (resip::TransportType protocol, int port, resip::IpVersion version=resip::V4, resip::StunSetting stun=resip::StunDisabled, const resip::Data &ipInterface=resip::Data::Empty, const resip::Data &sipDomainname=resip::Data::Empty, const resip::Data &privateKeyPassPhrase=resip::Data::Empty, resip::SecurityTypes::SSLType sslType=resip::SecurityTypes::DynamicTLS, unsigned transportFlags=0, const resip::Data &certificateFilename=resip::Data::Empty, const resip::Data &privateKeyFilename=resip::Data::Empty, resip::SecurityTypes::TlsClientVerificationMode cvm=resip::SecurityTypes::None, bool useEmailAsSIP=false, unsigned int rcvBufLen=0)
	Adds a network transport to use for send/receiving SIP messages.

std::vector< TransportInfo > &	getTransports ()
	Gets a vector of the transports previously added.

void	addEnumSuffix (const resip::Data &enumSuffix)
	Adds a domain suffix used in ENUM DNS queries.

const std::vector< resip::Data > &	getEnumSuffixes () const
	Gets a vector of the ENUM domain suffixes previously added.

void	addAdditionalDnsServer (const resip::Data &dnsServerIPAddress)
	Adds an additional DNS server to ones that are attempted to be discovered by the SIP stack.

const resip::DnsStub::NameserverList &	getAdditionalDnsServers () const
	Gets a vector of the DNS Servers previously added.

virtual resip::Data &	certPath ()
	Get/Set the location where the SIP stack will look for X509 certificates.

virtual const resip::Data	certPath () const

virtual std::vector< resip::Data > &	rootCertDirectories ()
	Get/Set the locations where the SIP stack will look for X.509 trusted root certificates.

virtual const std::vector< resip::Data > &	rootCertDirectories () const

virtual std::vector< resip::Data > &	rootCertBundles ()
	Get/Set the names of files containing bundles of X.509 trusted root certificates.

virtual const std::vector< resip::Data > &	rootCertBundles () const

virtual bool &	statisticsManagerEnabled ()
	Get/Set wether SIP message statistics are send to logging subsystem.

virtual const bool	statisticsManagerEnabled () const

virtual bool &	serverAuthManagerEnabled ()
	Get/Set wether Server Auth Manager is enabled or not.

virtual const bool	serverAuthManagerEnabled () const

virtual unsigned short &	rtpPortRangeMin ()
	Get/Set the starting port number in the range of valid port numbers to be used for RTP traffic.

virtual const unsigned short	rtpPortRangeMin () const

virtual unsigned short &	rtpPortRangeMax ()
	Get/Set the ending port number in the range of valid port numbers to be used for RTP traffic.

virtual const unsigned short	rtpPortRangeMax () const

virtual int &	subscriptionRetryInterval ()
	Get/Set the interval at which subscriptions are retried if they fail (if one is not suggested in the failure).

virtual const int	subscriptionRetryInterval () const

Public Member Functions inherited from resip::MasterProfile
	MasterProfile ()
	Creates an Identity/Profile with no BaseProfile - this is the root of all profiles.

virtual void	addSupportedScheme (const Data &scheme)
	Default is "sip".

virtual bool	isSchemeSupported (const Data &scheme) const

virtual void	clearSupportedSchemes () noexcept

virtual void	addSupportedMethod (const MethodTypes &method)
	Defaults are: INVITE, ACK, CANCEL, OPTIONS, BYE, UPDATE.

virtual void	removeSupportedMethod (const MethodTypes &method)

virtual bool	isMethodSupported (MethodTypes method) const

virtual Tokens	getAllowedMethods () const

virtual Data	getAllowedMethodsData () const

virtual void	clearSupportedMethods () noexcept

virtual void	addSupportedOptionTag (const Token &tag)
	Default is none. Do not use to enable PRACK(100rel) support.

virtual Tokens	getUnsupportedOptionsTags (const Tokens &requiresOptionTags)

virtual Tokens	getSupportedOptionTags () const

virtual void	clearSupportedOptionTags () noexcept

virtual void	setUacReliableProvisionalMode (ReliableProvisionalMode mode) noexcept

virtual ReliableProvisionalMode	getUacReliableProvisionalMode () const noexcept

virtual void	setUasReliableProvisionalMode (ReliableProvisionalMode mode) noexcept

virtual ReliableProvisionalMode	getUasReliableProvisionalMode () const noexcept

virtual void	addSupportedMimeType (const MethodTypes &method, const Mime &mimeType)
	Default is application/sdp for INVITE, OPTIONS, PRACK and UPDATE Methods.

virtual bool	removeSupportedMimeType (const MethodTypes &method, const Mime &mimeType)

virtual bool	isMimeTypeSupported (const MethodTypes &method, const Mime &mimeType)

virtual Mimes	getSupportedMimeTypes (const MethodTypes &method)

virtual void	clearSupportedMimeTypes (const MethodTypes &method)

virtual void	clearSupportedMimeTypes () noexcept

virtual void	addSupportedEncoding (const Token &encoding)
	Default is no encoding.

virtual bool	isContentEncodingSupported (const Token &contentEncoding) const

virtual Tokens	getSupportedEncodings () const

virtual void	clearSupportedEncodings () noexcept

virtual void	addSupportedLanguage (const Token &lang)
	Default is all - if nothing is set, then all are allowed.

virtual bool	isLanguageSupported (const Tokens &lang) const

virtual Tokens	getSupportedLanguages () const

virtual void	clearSupportedLanguages () noexcept

virtual void	addAllowedEvent (const Token &event)
	Default is to not send an Allow-Events header.

virtual bool	isEventAllowed (const Tokens &event) const

virtual Tokens	getAllowedEvents () const

virtual void	clearAllowedEvents () noexcept

virtual bool &	validateContentEnabled () noexcept
	enable/disable content validation

virtual bool	validateContentEnabled () const noexcept

virtual bool &	validateContentLanguageEnabled () noexcept
	enable/disable content language validation

virtual bool	validateContentLanguageEnabled () const noexcept

virtual bool &	validateAcceptEnabled () noexcept
	enable/disable Accept header validation

virtual bool	validateAcceptEnabled () const noexcept

virtual bool &	allowBadRegistrationEnabled () noexcept
	Set this to allow the Registration Server to accept registration requests that contain a To Tag.

virtual bool	allowBadRegistrationEnabled () const noexcept

virtual uint32_t &	serverRegistrationMinExpiresTime () noexcept
	Used when receiving a REGISTER request, if the expires value in the request is less than this time, then dum will reject the message with a 423 and set the min-expires header to the value specified here.

virtual uint32_t	serverRegistrationMinExpiresTime () const noexcept

virtual uint32_t &	serverRegistrationMaxExpiresTime () noexcept
	If an inbound REGISTER has an Expires header or any individual contact bindings with expires greater than this value, use this Max expires instead of the one given by the client.

virtual uint32_t	serverRegistrationMaxExpiresTime () const noexcept

virtual uint32_t &	serverRegistrationDefaultExpiresTime () noexcept
	If no Expires header or individual contact bindings specify an expiration value, use this value.

virtual uint32_t	serverRegistrationDefaultExpiresTime () const noexcept

virtual bool &	checkReqUriInMergeDetectionEnabled () noexcept
	Set this to include the RequestURI in merge request detection.

virtual bool	checkReqUriInMergeDetectionEnabled () const noexcept

virtual bool &	additionalTransactionTerminatingResponsesEnabled () noexcept
	Enabling this setting will allow the application layer to provide additional SIP responses, from class 4xx, 5xx, 6xx, that will lead to transaction termination instead of other failure effects like dialog termination, as defined by method Helper::determineFailureMessageEffect.

virtual bool	additionalTransactionTerminatingResponsesEnabled () const noexcept

virtual void	addAdditionalTransactionTerminatingResponses (int code)

virtual bool	isAdditionalTransactionTerminatingResponse (int code) const

virtual const std::set< int > &	getAdditionalTransactionTerminatingResponses () const

virtual void	clearAdditionalTransactionTerminatingResponses () noexcept

Public Member Functions inherited from resip::UserProfile
	UserProfile ()

	UserProfile (std::shared_ptr< Profile > baseProfile)

virtual	~UserProfile ()

virtual void	setDefaultFrom (const NameAddr &from)

virtual NameAddr &	getDefaultFrom () noexcept

virtual void	setServiceRoute (const NameAddrs &sRoute)

virtual NameAddrs &	getServiceRoute () noexcept

virtual void	setImsAuthUser (const Data &userName, const Data &host)

virtual Data &	getImsAuthUserName () noexcept

virtual Data &	getImsAuthHost () noexcept

virtual std::shared_ptr< UserProfile >	getAnonymousUserProfile () const

bool	isAnonymous () const

virtual void	addGruu (const Data &aor, const NameAddr &contact)

virtual bool	hasGruu (const Data &aor) const

virtual bool	hasGruu (const Data &aor, const Data &instance) const

virtual NameAddr &	getGruu (const Data &aor)

virtual NameAddr &	getGruu (const Data &aor, const NameAddr &contact)

virtual bool &	gruuEnabled () noexcept

virtual bool	gruuEnabled () const noexcept

virtual bool	hasPublicGruu () const

virtual const Uri &	getPublicGruu () const noexcept

virtual void	setPublicGruu (const Uri &gruu)

virtual bool	hasTempGruu () const

virtual const Uri &	getTempGruu () const noexcept

virtual void	setTempGruu (const Uri &gruu)

virtual void	clearDigestCredentials () noexcept
	The following functions deal with clearing, setting and getting of digest credentals.

virtual void	setDigestCredential (const Data &realm, const Data &user, const Data &password, bool isPasswordA1Hash=false)
	For the password you may either provide the plain text password (isPasswordA1Hash = false) or the Digest A1 MD5 Hash (isPasswordA1Hash = true).

virtual const DigestCredential &	getDigestCredential (const Data &realm)

virtual void	setDigestCacheUseLimit (unsigned long digestCacheUseLimit) noexcept

virtual unsigned long	getDigestCacheUseLimit () const noexcept

virtual bool &	clientOutboundEnabled () noexcept

virtual bool	clientOutboundEnabled () const noexcept

virtual bool	hasInstanceId ()

virtual void	setInstanceId (const Data &id)

virtual const Data &	getInstanceId () const noexcept

virtual void	setRegId (int regId) noexcept

virtual int	getRegId () noexcept

const Tuple &	getClientOutboundFlowTuple () const noexcept

void	clearClientOutboundFlowTuple ()

void	setClientOutboundFlowTuple (const Tuple &outboundFlowTuple)

Public Member Functions inherited from resip::Profile
	Profile ()

	Profile (std::shared_ptr< Profile > baseProfile)

	Profile (const Profile &)=default

	Profile (Profile &&)=default

virtual	~Profile ()=default

Profile &	operator= (const Profile &)=default

Profile &	operator= (Profile &&)=default

virtual void	reset ()
	Reset this profile to it's initial state - (same as calling unsetXXX for each setting) If no fall through (base) profile was provided as creation time.

virtual void	setDefaultRegistrationTime (uint32_t secs) noexcept
	Note: setXXXX methods will set this setting internally in this object.

virtual uint32_t	getDefaultRegistrationTime () const noexcept

virtual void	unsetDefaultRegistrationTime () noexcept

virtual void	setDefaultMaxRegistrationTime (uint32_t secs) noexcept
	If a registration gets rejected with a 423, then we ensure the MinExpires value is less than this before re-registering Set to 0 to disable this check and accept any time suggested by the server.

virtual uint32_t	getDefaultMaxRegistrationTime () const noexcept

virtual void	unsetDefaultMaxRegistrationTime () noexcept

virtual void	setDefaultRegistrationRetryTime (int secs) noexcept
	The time to retry registrations on error responses (if Retry-After header is not present in error) Set to 0 to never retry on errors.

virtual int	getDefaultRegistrationRetryTime () const noexcept

virtual void	unsetDefaultRegistrationRetryTime () noexcept

virtual void	setDefaultSubscriptionTime (uint32_t secs) noexcept
	This default is used if no value is passed in when creating a subscription.

virtual uint32_t	getDefaultSubscriptionTime () const noexcept

virtual void	unsetDefaultSubscriptionTime () noexcept

virtual void	setDefaultPublicationTime (uint32_t secs) noexcept
	This default is used if no value is passed in when creating a publication.

virtual uint32_t	getDefaultPublicationTime () const noexcept

virtual void	unsetDefaultPublicationTime () noexcept

virtual void	setDefaultStaleCallTime (int secs) noexcept
	Call is stale if UAC gets no final response within the stale call timeout (default 3 minutes)

virtual int	getDefaultStaleCallTime () const noexcept

virtual void	unsetDefaultStaleCallTime () noexcept

virtual void	setDefaultStaleReInviteTime (int secs) noexcept
	ReInvite is stale if UAC gets no final response within the stale reinvite timeout (default 40 seconds)

virtual int	getDefaultStaleReInviteTime () const noexcept

virtual void	unsetDefaultStaleReInviteTime () noexcept

virtual void	setDefaultSessionTime (uint32_t secs) noexcept
	Only used if timer option tag is set in MasterProfile.

virtual uint32_t	getDefaultSessionTime () const noexcept

virtual void	unsetDefaultSessionTime () noexcept

virtual void	setDefaultSessionTimerMode (Profile::SessionTimerMode mode) noexcept

virtual Profile::SessionTimerMode	getDefaultSessionTimerMode () const noexcept

virtual void	unsetDefaultSessionTimerMode () noexcept

virtual void	set1xxRetransmissionTime (int secs) noexcept
	The amount of time that can pass before dum will resubmit an unreliable provisional response.

virtual int	get1xxRetransmissionTime () const noexcept

virtual void	unset1xxRetransmissionTime () noexcept

virtual void	set1xxRelResubmitTime (int secs) noexcept
	The amount of time that can pass before dum will resubmit a reliable provisional response.

virtual int	get1xxRelResubmitTime () const noexcept

virtual void	unset1xxRelResubmitTime () noexcept

virtual void	setOverrideHostAndPort (const Uri &hostPort)
	overrides the value used to populate the contact ?dcm? – also change via entries? Also, dum currently uses(as a uas) the request uri of the dialog constructing request for the local contact within that dialog.

virtual bool	hasOverrideHostAndPort () const noexcept

virtual const Uri &	getOverrideHostAndPort () const

virtual void	unsetOverrideHostAndPort () noexcept

virtual void	addAdvertisedCapability (Headers::Type header)
	enable/disable sending of Allow/Supported/Accept-Language/Accept-Encoding headers on initial outbound requests (ie.

virtual bool	isAdvertisedCapability (Headers::Type header) const

virtual void	clearAdvertisedCapabilities () noexcept

virtual void	unsetAdvertisedCapabilities ()

virtual void	setOutboundProxy (const Uri &uri)
	Use to route all outbound requests through a particular proxy.

virtual const NameAddr &	getOutboundProxy () const

virtual bool	hasOutboundProxy () const noexcept

virtual void	unsetOutboundProxy () noexcept

virtual void	setForceOutboundProxyOnAllRequestsEnabled (bool enabled) noexcept
	If enabled, forces use of outbound proxy on all requests, including mid-dialog requests.

virtual bool	getForceOutboundProxyOnAllRequestsEnabled () const noexcept

virtual void	unsetForceOutboundProxyOnAllRequestsEnabled () noexcept

virtual void	setExpressOutboundAsRouteSetEnabled (bool enabled) noexcept
	If enabled, add a route header for the outbound proxy.

virtual bool	getExpressOutboundAsRouteSetEnabled () const noexcept

virtual void	unsetExpressOutboundAsRouteSetEnabled () noexcept

virtual void	setRportEnabled (bool enabled) noexcept
	enable/disable rport for requests. rport is enabled by default

virtual bool	getRportEnabled () const noexcept

virtual void	unsetRportEnabled () noexcept

virtual void	setUserAgent (const Data &userAgent)
	if set then UserAgent header is added to outbound messages

virtual const Data &	getUserAgent () const

virtual bool	hasUserAgent () const noexcept

virtual void	unsetUserAgent () noexcept

virtual void	setProxyRequires (const Tokens &proxyRequires)
	if set then ProxyRequires header is added to outbound messages

virtual const Tokens &	getProxyRequires () const

virtual bool	hasProxyRequires () const noexcept

virtual void	unsetProxyRequires () noexcept

virtual void	setKeepAliveTimeForDatagram (int keepAliveTime) noexcept
	time between CR/LF keepalive messages in seconds.

virtual int	getKeepAliveTimeForDatagram () const noexcept

virtual void	unsetKeepAliveTimeForDatagram () noexcept

virtual void	setKeepAliveTimeForStream (int keepAliveTime) noexcept

virtual int	getKeepAliveTimeForStream () const noexcept

virtual void	unsetKeepAliveTimeForStream () noexcept

virtual void	setFixedTransportPort (int fixedTransportPort) noexcept
	If set dum will provide a port in the via for requests sent down to the stack.

virtual int	getFixedTransportPort () const noexcept

virtual void	unsetFixedTransportPort () noexcept

virtual void	setFixedTransportInterface (const Data &fixedTransportInterface)
	If set dum will provide a interface in the via for requests sent down to the stack.

virtual const Data &	getFixedTransportInterface () const

virtual void	unsetFixedTransportInterface ()

virtual void	setRinstanceEnabled (bool enabled) noexcept
	If enabled then rinstance parameter is added to contacts.

virtual bool	getRinstanceEnabled () const noexcept

virtual void	unsetRinstanceEnabled () noexcept

virtual void	setOutboundDecorator (std::shared_ptr< MessageDecorator > outboundDecorator) noexcept

virtual std::shared_ptr< MessageDecorator >	getOutboundDecorator () noexcept

virtual void	unsetOutboundDecorator () noexcept

virtual void	setMethodsParamEnabled (bool enabled) noexcept
	If enabled then methods parameter is added to contacts.

virtual bool	getMethodsParamEnabled () const noexcept

virtual void	unsetMethodsParamEnabled () noexcept

virtual void	setUserAgentCapabilities (const NameAddr &capabilities)
	If set, the parameters on the provided NameAddr are used in the contact header Example: include <resip/stack/ExtensionParameter.hxx> static const resip::ExtensionParameter p_automaton("automaton"); static const resip::ExtensionParameter p_byeless("+sip.byeless"); static const resip::ExtensionParameter p_rendering("+sip.rendering"); ... NameAddr capabilities; capabilities.param(p_automaton); capabilities.param(p_byeless); capabilities.param(p_rendering) = "\"no\""; profile->setUserAgentCapabilities(capabilities);.

virtual bool	hasUserAgentCapabilities () const noexcept

virtual const NameAddr &	getUserAgentCapabilities () const

virtual void	unsetUserAgentCapabilities () noexcept

virtual void	setExtraHeadersInReferNotifySipFragEnabled (bool enabled) noexcept
	If enabled then dialog identifying headers are added to SipFrag bodies that are generated in an InviteSession.

virtual bool	getExtraHeadersInReferNotifySipFragEnabled () const noexcept

virtual void	unsetExtraHeadersInReferNotifySipFragEnabled () noexcept

virtual void	setHandleInviteSession491AsGeneralFailureEnabled (bool enabled)

virtual bool	getHandleInviteSession491AsGeneralFailureEnabled () const

virtual void	unsetHandleInviteSession491AsGeneralFailureEnabled ()

Additional Inherited Members
Public Types inherited from resip::MasterProfile
enum	ReliableProvisionalMode { Never , SupportedEssential , Supported , Required }

Public Types inherited from resip::Profile
enum	SessionTimerMode { PreferLocalRefreshes , PreferRemoteRefreshes , PreferCallerRefreshes , PreferCalleeRefreshes }
	Only used if timer option tag is set in MasterProfile. More...

Detailed Description

This class extends the resip MasterProfile to include UserAgent specific settings.

Author: Scott Godin (sgodin AT SipSpectrum DOT com)

Definition at line 24 of file UserAgentMasterProfile.hxx.

Constructor & Destructor Documentation

◆ UserAgentMasterProfile()

UserAgentMasterProfile::UserAgentMasterProfile ( )

Definition at line 14 of file UserAgentMasterProfile.cxx.

Member Function Documentation

◆ addAdditionalDnsServer()

void UserAgentMasterProfile::addAdditionalDnsServer ( const resip::Data & dnsServerIPAddress )

Adds an additional DNS server to ones that are attempted to be discovered by the SIP stack.

Note: This MUST be called before the UserAgent is created

Parameters

dnsServerIPAddress IP Address of DNS server to add

Definition at line 126 of file UserAgentMasterProfile.cxx.

◆ addEnumSuffix()

void UserAgentMasterProfile::addEnumSuffix ( const resip::Data & enumSuffix )

Adds a domain suffix used in ENUM DNS queries.

For example: e164.arpa

Note: This MUST be called before the UserAgent is created

Parameters

enumSuffix ENUM Domain suffix to add

Definition at line 114 of file UserAgentMasterProfile.cxx.

◆ addTransport()

void UserAgentMasterProfile::addTransport	(	resip::TransportType	protocol,
		int	port,
		resip::IpVersion	version = `resip::V4`,
		resip::StunSetting	stun = `resip::StunDisabled`,
		const resip::Data &	ipInterface = `resip::Data::Empty`,
		const resip::Data &	sipDomainname = `resip::Data::Empty`,
		const resip::Data &	privateKeyPassPhrase = `resip::Data::Empty`,
		resip::SecurityTypes::SSLType	sslType = `resip::SecurityTypes::DynamicTLS`,
		unsigned	transportFlags = `0`,
		const resip::Data &	certificateFilename = `resip::Data::Empty`,
		const resip::Data &	privateKeyFilename = `resip::Data::Empty`,
		resip::SecurityTypes::TlsClientVerificationMode	cvm = `resip::SecurityTypes::None`,
		bool	useEmailAsSIP = `false`,
		unsigned int	rcvBufLen = `0`
	)

Adds a network transport to use for send/receiving SIP messages.

Note: This MUST be called before the UserAgent is created

Parameters

protocol	Transport type: UDP,TCP or TLS
port	UDP or TCP port to listen on
version	IP Version: V4 or V6
ipInterface	IP Interface to bind to - empty string binds to all interfaces
sipDomainname	TLS Domain name - only used if protocol is TLS
sslType	DynamicTLS vs TLSv1 - only use if protocol is TLS

Definition at line 71 of file UserAgentMasterProfile.cxx.

◆ certPath() [1/2]

Data & UserAgentMasterProfile::certPath ( )

virtual

Get/Set the location where the SIP stack will look for X509 certificates.

Note: This MUST be called before the UserAgent is created

Returns: Data cert path location

Definition at line 138 of file UserAgentMasterProfile.cxx.

◆ certPath() [2/2]

const Data UserAgentMasterProfile::certPath ( ) const

virtual

Definition at line 144 of file UserAgentMasterProfile.cxx.

◆ dtmfDigitLoggingEnabled() [1/2]

bool & UserAgentMasterProfile::dtmfDigitLoggingEnabled ( )

virtual

Get/Set wether recon is allowed to log DTMF digits pressed.

Defaults to enabled. Disable for applications that accept credit card information for security purposes.

Returns: bool Set to false to disable logging DTMF digits

Definition at line 59 of file UserAgentMasterProfile.cxx.

◆ dtmfDigitLoggingEnabled() [2/2]

const bool UserAgentMasterProfile::dtmfDigitLoggingEnabled ( ) const

virtual

Definition at line 65 of file UserAgentMasterProfile.cxx.

◆ getAdditionalDnsServers()

const DnsStub::NameserverList & UserAgentMasterProfile::getAdditionalDnsServers ( ) const

Gets a vector of the DNS Servers previously added.

Note: This does not include DNS servers detected by the stack

Returns: Reference to a vector of DNS server IP Addresses

Definition at line 132 of file UserAgentMasterProfile.cxx.

◆ getEnumSuffixes()

const std::vector< Data > & UserAgentMasterProfile::getEnumSuffixes ( ) const

Gets a vector of the ENUM domain suffixes previously added.

Returns: Reference to a vector of ENUM domain suffixes

Definition at line 120 of file UserAgentMasterProfile.cxx.

◆ getRTCPEventLoggingHandler()

std::shared_ptr< flowmanager::RTCPEventLoggingHandler > UserAgentMasterProfile::getRTCPEventLoggingHandler ( ) const

noexcept

Definition at line 53 of file UserAgentMasterProfile.cxx.

◆ getTransports()

std::vector< UserAgentMasterProfile::TransportInfo > & UserAgentMasterProfile::getTransports ( )

Gets a vector of the transports previously added.

Returns: Reference to a vector of TransportInfo's. Note: Not returning as const since we want to set the actual port used if a an ephemeral port was specified

Definition at line 108 of file UserAgentMasterProfile.cxx.

◆ getTransportSipMessageLoggingHandler()

std::shared_ptr< Transport::SipMessageLoggingHandler > UserAgentMasterProfile::getTransportSipMessageLoggingHandler ( ) const

noexcept

Definition at line 41 of file UserAgentMasterProfile.cxx.

◆ rootCertBundles() [1/2]

std::vector< Data > & UserAgentMasterProfile::rootCertBundles ( )

virtual

Get/Set the names of files containing bundles of X.509 trusted root certificates.

Note: This MUST be called before the UserAgent is created

Returns: Data cert path location

Definition at line 162 of file UserAgentMasterProfile.cxx.

◆ rootCertBundles() [2/2]

const std::vector< Data > & UserAgentMasterProfile::rootCertBundles ( ) const

virtual

Definition at line 168 of file UserAgentMasterProfile.cxx.

◆ rootCertDirectories() [1/2]

std::vector< Data > & UserAgentMasterProfile::rootCertDirectories ( )

virtual

Get/Set the locations where the SIP stack will look for X.509 trusted root certificates.

Note: This MUST be called before the UserAgent is created

Returns: Data root cert directory location

Definition at line 150 of file UserAgentMasterProfile.cxx.

◆ rootCertDirectories() [2/2]

const std::vector< Data > & UserAgentMasterProfile::rootCertDirectories ( ) const

virtual

Definition at line 156 of file UserAgentMasterProfile.cxx.

◆ rtpPortRangeMax() [1/2]

unsigned short & UserAgentMasterProfile::rtpPortRangeMax ( )

virtual

Get/Set the ending port number in the range of valid port numbers to be used for RTP traffic.

Note: This MUST be called before the UserAgent is created

Returns: unsigned short range max

Definition at line 210 of file UserAgentMasterProfile.cxx.

◆ rtpPortRangeMax() [2/2]

const unsigned short UserAgentMasterProfile::rtpPortRangeMax ( ) const

virtual

Definition at line 216 of file UserAgentMasterProfile.cxx.

◆ rtpPortRangeMin() [1/2]

unsigned short & UserAgentMasterProfile::rtpPortRangeMin ( )

virtual

Get/Set the starting port number in the range of valid port numbers to be used for RTP traffic.

Note: This MUST be called before the UserAgent is created

Returns: unsigned short range min

Definition at line 198 of file UserAgentMasterProfile.cxx.

◆ rtpPortRangeMin() [2/2]

const unsigned short UserAgentMasterProfile::rtpPortRangeMin ( ) const

virtual

Definition at line 204 of file UserAgentMasterProfile.cxx.

◆ serverAuthManagerEnabled() [1/2]

bool & UserAgentMasterProfile::serverAuthManagerEnabled ( )

virtual

Get/Set wether Server Auth Manager is enabled or not.

Note: ServerAuthManager must be enabled to support challengeOODReferRequests and challengeAutoAnswerRequests ConversationProfile settings.

Returns: bool Set to true to enable server auth manager

Definition at line 186 of file UserAgentMasterProfile.cxx.

◆ serverAuthManagerEnabled() [2/2]

const bool UserAgentMasterProfile::serverAuthManagerEnabled ( ) const

virtual

Definition at line 192 of file UserAgentMasterProfile.cxx.

◆ setRTCPEventLoggingHandler()

void UserAgentMasterProfile::setRTCPEventLoggingHandler ( std::shared_ptr< flowmanager::RTCPEventLoggingHandler > handler )

noexcept

Definition at line 47 of file UserAgentMasterProfile.cxx.

◆ setTransportSipMessageLoggingHandler()

void UserAgentMasterProfile::setTransportSipMessageLoggingHandler ( std::shared_ptr< resip::Transport::SipMessageLoggingHandler > handler )

noexcept

Definition at line 35 of file UserAgentMasterProfile.cxx.

◆ statisticsManagerEnabled() [1/2]

bool & UserAgentMasterProfile::statisticsManagerEnabled ( )

virtual

Get/Set wether SIP message statistics are send to logging subsystem.

Returns: bool Set to true to enable statistics

Definition at line 174 of file UserAgentMasterProfile.cxx.

◆ statisticsManagerEnabled() [2/2]

const bool UserAgentMasterProfile::statisticsManagerEnabled ( ) const

virtual

Definition at line 180 of file UserAgentMasterProfile.cxx.

◆ subscriptionRetryInterval() [1/2]

int & UserAgentMasterProfile::subscriptionRetryInterval ( )

virtual

Get/Set the interval at which subscriptions are retried if they fail (if one is not suggested in the failure).

Note: This MUST be called before the UserAgent is created

Returns: int subscription retry interval in seconds

Definition at line 222 of file UserAgentMasterProfile.cxx.

◆ subscriptionRetryInterval() [2/2]

const int UserAgentMasterProfile::subscriptionRetryInterval ( ) const

virtual

Definition at line 228 of file UserAgentMasterProfile.cxx.

The documentation for this class was generated from the following files:

resip/recon/UserAgentMasterProfile.hxx
resip/recon/UserAgentMasterProfile.cxx

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UserAgentMasterProfile()

Member Function Documentation

◆ addAdditionalDnsServer()

◆ addEnumSuffix()

◆ addTransport()

◆ certPath() [1/2]

◆ certPath() [2/2]

◆ dtmfDigitLoggingEnabled() [1/2]

◆ dtmfDigitLoggingEnabled() [2/2]

◆ getAdditionalDnsServers()

◆ getEnumSuffixes()

◆ getRTCPEventLoggingHandler()

◆ getTransports()

◆ getTransportSipMessageLoggingHandler()

◆ rootCertBundles() [1/2]

◆ rootCertBundles() [2/2]

◆ rootCertDirectories() [1/2]

◆ rootCertDirectories() [2/2]

◆ rtpPortRangeMax() [1/2]

◆ rtpPortRangeMax() [2/2]

◆ rtpPortRangeMin() [1/2]

◆ rtpPortRangeMin() [2/2]

◆ serverAuthManagerEnabled() [1/2]

◆ serverAuthManagerEnabled() [2/2]

◆ setRTCPEventLoggingHandler()

◆ setTransportSipMessageLoggingHandler()

◆ statisticsManagerEnabled() [1/2]

◆ statisticsManagerEnabled() [2/2]

◆ subscriptionRetryInterval() [1/2]

◆ subscriptionRetryInterval() [2/2]