dcm! – shutdown/deletion API – end? More...

#include <ClientRegistration.hxx>

Inheritance diagram for resip::ClientRegistration:

Public Member Functions
	ClientRegistration (DialogUsageManager &dum, DialogSet &dialog, std::shared_ptr< SipMessage > req)

	ClientRegistration (const ClientRegistration &)=delete

	ClientRegistration (ClientRegistration &&)=delete

ClientRegistration &	operator= (const ClientRegistration &)=delete

ClientRegistration &	operator= (ClientRegistration &&)=delete

ClientRegistrationHandle	getHandle ()

void	addBinding (const NameAddr &contact)
	Adds a registration binding, using the registration from the UserProfile.

void	addBinding (const NameAddr &contact, uint32_t registrationTime)
	Adds a registration binding, using the specified registration time.

void	removeBinding (const NameAddr &contact)
	Removes one particular binding.

void	removeAll (bool stopRegisteringWhenDone=false)
	Removes all bindings associated with the AOR - even those that may have been by a another UA.

void	removeMyBindings (bool stopRegisteringWhenDone=false)
	Removes all bindings added by addBinding.

void	requestRefresh (uint32_t expires=0)
	Request a manual refresh of the registration.

void	stopRegistering ()
	kills the usgage, does not unregister, call removeMyBindings to unregister

const NameAddrs &	myContacts () const noexcept
	returns a list of contacts added by addBinding

const NameAddrs &	allContacts () const noexcept
	returns a list of all contacts for this AOR - may include those added by other UA's

uint32_t	whenExpires () const
	returns the number of seconds until the registration expires - relative, returns 0 if already expired

void	end () override
	Calls removeMyBindings and ends usage when complete.

bool	isRequestPending () const noexcept
	Returns true if a REGISTER request is currently pending and we are waiting for the SIP Response.

void	removeMyBindingsCommand (bool stopRegisteringWhenDone=false)
	Provide asynchronous method access by using command.

virtual void	endCommand ()

void	dispatch (const SipMessage &msg) override

void	dispatch (const DumTimeout &timer) override

EncodeStream &	dump (EncodeStream &strm) const override

Public Member Functions inherited from resip::NonDialogUsage
AppDialogSetHandle	getAppDialogSet () const

std::shared_ptr< UserProfile >	getUserProfile () const noexcept

virtual void	send (std::shared_ptr< SipMessage > msg)

virtual void	sendCommand (std::shared_ptr< SipMessage > msg)

Public Member Functions inherited from resip::BaseUsage
virtual void	postDum (Message *messageForDum)
	posts a message on dum

Public Member Functions inherited from resip::Handled
	Handled (HandleManager &ham)

virtual	~Handled ()

Static Public Member Functions
static void	tagContact (NameAddr &contact, DialogUsageManager &dum, const std::shared_ptr< UserProfile > &userProfile)

Protected Member Functions
virtual	~ClientRegistration ()

Protected Member Functions inherited from resip::NonDialogUsage
	NonDialogUsage (DialogUsageManager &dum, DialogSet &dialogSet)

virtual	~NonDialogUsage ()

void	applyLocalContact (SipMessage &response, const SipMessage &request) const

Protected Member Functions inherited from resip::BaseUsage
	BaseUsage (DialogUsageManager &dum)

virtual	~BaseUsage ()

BaseUsageHandle	getBaseHandle () const

Friends
class	DialogSet

Additional Inherited Members
Public Types inherited from resip::Handled
enum	{ npos = 0 }

typedef unsigned long	Id

Protected Attributes inherited from resip::NonDialogUsage
DialogSet &	mDialogSet

Protected Attributes inherited from resip::BaseUsage
DialogUsageManager &	mDum

Protected Attributes inherited from resip::Handled
HandleManager &	mHam

Handled::Id	mId

Detailed Description

dcm! – shutdown/deletion API – end?

Definition at line 16 of file ClientRegistration.hxx.

Constructor & Destructor Documentation

◆ ClientRegistration() [1/3]

ClientRegistration::ClientRegistration	(	DialogUsageManager &	dum,
		DialogSet &	dialog,
		std::shared_ptr< SipMessage >	req
	)

Definition at line 34 of file ClientRegistration.cxx.

◆ ClientRegistration() [2/3]

resip::ClientRegistration::ClientRegistration ( const ClientRegistration & )

delete

◆ ClientRegistration() [3/3]

resip::ClientRegistration::ClientRegistration ( ClientRegistration && )

delete

◆ ~ClientRegistration()

ClientRegistration::~ClientRegistration ( )

protectedvirtual

Definition at line 71 of file ClientRegistration.cxx.

Member Function Documentation

◆ addBinding() [1/2]

void ClientRegistration::addBinding ( const NameAddr & contact )

Adds a registration binding, using the registration from the UserProfile.

Definition at line 81 of file ClientRegistration.cxx.

◆ addBinding() [2/2]

void ClientRegistration::addBinding	(	const NameAddr &	contact,
		uint32_t	registrationTime
	)

Adds a registration binding, using the specified registration time.

Definition at line 117 of file ClientRegistration.cxx.

◆ allContacts()

const NameAddrs & ClientRegistration::allContacts ( ) const

noexcept

returns a list of all contacts for this AOR - may include those added by other UA's

Definition at line 334 of file ClientRegistration.cxx.

◆ dispatch() [1/2]

void ClientRegistration::dispatch ( const DumTimeout & timer )

overridevirtual

Implements resip::BaseUsage.

Definition at line 968 of file ClientRegistration.cxx.

◆ dispatch() [2/2]

void ClientRegistration::dispatch ( const SipMessage & msg )

overridevirtual

Implements resip::BaseUsage.

Definition at line 401 of file ClientRegistration.cxx.

◆ dump()

EncodeStream & ClientRegistration::dump ( EncodeStream & strm ) const

overridevirtual

Implements resip::BaseUsage.

Definition at line 394 of file ClientRegistration.cxx.

◆ end()

void ClientRegistration::end ( )

overridevirtual

Calls removeMyBindings and ends usage when complete.

Implements resip::BaseUsage.

Definition at line 354 of file ClientRegistration.cxx.

◆ endCommand()

void ClientRegistration::endCommand ( )

virtual

Definition at line 388 of file ClientRegistration.cxx.

◆ getHandle()

ClientRegistrationHandle ClientRegistration::getHandle ( )

Definition at line 29 of file ClientRegistration.cxx.

◆ isRequestPending()

bool resip::ClientRegistration::isRequestPending ( ) const

inlinenoexcept

Returns true if a REGISTER request is currently pending and we are waiting for the SIP Response.

Definition at line 68 of file ClientRegistration.hxx.

◆ myContacts()

const NameAddrs & ClientRegistration::myContacts ( ) const

noexcept

returns a list of contacts added by addBinding

Definition at line 328 of file ClientRegistration.cxx.

◆ operator=() [1/2]

ClientRegistration & resip::ClientRegistration::operator= ( ClientRegistration && )

delete

◆ operator=() [2/2]

ClientRegistration & resip::ClientRegistration::operator= ( const ClientRegistration & )

delete

◆ removeAll()

void ClientRegistration::removeAll ( bool stopRegisteringWhenDone = false )

Removes all bindings associated with the AOR - even those that may have been by a another UA.

Note: Set's contact header to '*'. Set flag to true to end the usage when complete.

Definition at line 169 of file ClientRegistration.cxx.

◆ removeBinding()

void ClientRegistration::removeBinding ( const NameAddr & contact )

Removes one particular binding.

Definition at line 136 of file ClientRegistration.cxx.

◆ removeMyBindings()

void ClientRegistration::removeMyBindings ( bool stopRegisteringWhenDone = false )

Removes all bindings added by addBinding.

Set flag to true to end the usage when complete

Definition at line 197 of file ClientRegistration.cxx.

◆ removeMyBindingsCommand()

void ClientRegistration::removeMyBindingsCommand ( bool stopRegisteringWhenDone = false )

Provide asynchronous method access by using command.

Definition at line 271 of file ClientRegistration.cxx.

◆ requestRefresh()

void ClientRegistration::requestRefresh ( uint32_t expires = 0 )

Request a manual refresh of the registration.

If 0 then default to using original expires value (to remove use removeXXX() instead)

Definition at line 284 of file ClientRegistration.cxx.

◆ stopRegistering()

void ClientRegistration::stopRegistering ( )

kills the usgage, does not unregister, call removeMyBindings to unregister

Definition at line 277 of file ClientRegistration.cxx.

◆ tagContact()

void ClientRegistration::tagContact	(	NameAddr &	contact,
		DialogUsageManager &	dum,
		const std::shared_ptr< UserProfile > &	userProfile
	)

static

Definition at line 718 of file ClientRegistration.cxx.

◆ whenExpires()

uint32_t ClientRegistration::whenExpires ( ) const

returns the number of seconds until the registration expires - relative, returns 0 if already expired

Definition at line 340 of file ClientRegistration.cxx.

Friends And Related Symbol Documentation

◆ DialogSet

friend class DialogSet

friend

Definition at line 109 of file ClientRegistration.hxx.

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

resip/dum/ClientRegistration.hxx
resip/dum/ClientRegistration.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClientRegistration() [1/3]

◆ ClientRegistration() [2/3]

◆ ClientRegistration() [3/3]

◆ ~ClientRegistration()

Member Function Documentation

◆ addBinding() [1/2]

◆ addBinding() [2/2]

◆ allContacts()

◆ dispatch() [1/2]

◆ dispatch() [2/2]

◆ dump()

◆ end()

◆ endCommand()

◆ getHandle()

◆ isRequestPending()

◆ myContacts()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ removeAll()

◆ removeBinding()

◆ removeMyBindings()

◆ removeMyBindingsCommand()

◆ requestRefresh()

◆ stopRegistering()

◆ tagContact()

◆ whenExpires()

Friends And Related Symbol Documentation

◆ DialogSet