#include <RegistrationHandler.hxx>

Inheritance diagram for resip::ServerRegistrationHandler:

Public Member Functions
virtual	~ServerRegistrationHandler ()=default

virtual void	onRefresh (ServerRegistrationHandle, const SipMessage &reg)=0
	Called when registration is refreshed.

virtual void	onRemove (ServerRegistrationHandle, const SipMessage &reg)=0
	called when one or more specified contacts is removed

virtual void	onRemoveAll (ServerRegistrationHandle, const SipMessage &reg)=0
	Called when all the contacts are removed using "Contact: *".

virtual void	onAdd (ServerRegistrationHandle, const SipMessage &reg)=0
	Called when one or more contacts are added.

virtual void	onQuery (ServerRegistrationHandle, const SipMessage &reg)=0
	Called when a client queries for the list of current registrations.

virtual void	getGlobalExpires (const SipMessage &msg, const std::shared_ptr< MasterProfile > &masterProfile, uint32_t &expires, uint32_t &returnCode)
	When processing a REGISTER request, return the desired expires value when processing the "Expires" header.

virtual void	getContactExpires (const NameAddr &contact, const std::shared_ptr< MasterProfile > &masterProfile, uint32_t &expires, uint32_t &returnCode)
	When processing a REGISTER request, return the desired expires value by processing this contact's expires parameter.

virtual bool	asyncProcessing (void) const
	If true, the registration processing will use the async* functions here and will not use the RegistrationPersistenceManager.

virtual void	asyncGetContacts (ServerRegistrationHandle, const Uri &aor)
	Called when a REGISTER is first received to retrieve the current list.

virtual void	asyncUpdateContacts (ServerRegistrationHandle, const Uri &aor, std::unique_ptr< ContactPtrList > modifiedContactList, std::unique_ptr< ContactRecordTransactionLog > transactionLog)
	Notifies the handler to update the current contact list for the AOR to the specified list that has been updated by DUM's registration processing.

virtual void	asyncRemoveExpired (ServerRegistrationHandle, const resip::Uri &aor, std::unique_ptr< resip::ContactPtrList > contacts)
	Notifies the handler to remove the entries specified in the contacts parameter.

Detailed Description

Definition at line 48 of file RegistrationHandler.hxx.

Constructor & Destructor Documentation

◆ ~ServerRegistrationHandler()

virtual resip::ServerRegistrationHandler::~ServerRegistrationHandler ( )

virtualdefault

Member Function Documentation

◆ asyncGetContacts()

virtual void resip::ServerRegistrationHandler::asyncGetContacts	(	ServerRegistrationHandle	,
		const Uri &	aor
	)

inlinevirtual

Called when a REGISTER is first received to retrieve the current list.

This list is then updated by the registration logic in DUM. When the list is ready, call asyncProvideContacts() on the specified ServerRegistration.

Definition at line 101 of file RegistrationHandler.hxx.

◆ asyncProcessing()

virtual bool resip::ServerRegistrationHandler::asyncProcessing ( void ) const

inlinevirtual

If true, the registration processing will use the async* functions here and will not use the RegistrationPersistenceManager.

Definition at line 93 of file RegistrationHandler.hxx.

◆ asyncRemoveExpired()

virtual void resip::ServerRegistrationHandler::asyncRemoveExpired	(	ServerRegistrationHandle	,
		const resip::Uri &	aor,
		std::unique_ptr< resip::ContactPtrList >	contacts
	)

inlinevirtual

Notifies the handler to remove the entries specified in the contacts parameter.

No further processing is required after receiving this message.

Definition at line 119 of file RegistrationHandler.hxx.

◆ asyncUpdateContacts()

virtual void resip::ServerRegistrationHandler::asyncUpdateContacts	(	ServerRegistrationHandle	,
		const Uri &	aor,
		std::unique_ptr< ContactPtrList >	modifiedContactList,
		std::unique_ptr< ContactRecordTransactionLog >	transactionLog
	)

inlinevirtual

Notifies the handler to update the current contact list for the AOR to the specified list that has been updated by DUM's registration processing.

This is normally called after the REGISTER has been processed and accepted by the user (ServerRegistration::accept())

Definition at line 109 of file RegistrationHandler.hxx.

◆ getContactExpires()

void ServerRegistrationHandler::getContactExpires	(	const NameAddr &	contact,
		const std::shared_ptr< MasterProfile > &	masterProfile,
		uint32_t &	expires,
		uint32_t &	returnCode
	)

virtual

When processing a REGISTER request, return the desired expires value by processing this contact's expires parameter.

If the expires value is not modified in this function the global expires will be used.

Parameters

expires	Set this to the desired expiration value for this contact.
returnCode	If the REGISTER should be rejected, use this return code. A value of 423 will result in the Min-Expires header added to the response.

Definition at line 72 of file RegistrationHandler.cxx.

◆ getGlobalExpires()

void ServerRegistrationHandler::getGlobalExpires	(	const SipMessage &	msg,
		const std::shared_ptr< MasterProfile > &	masterProfile,
		uint32_t &	expires,
		uint32_t &	returnCode
	)

virtual

When processing a REGISTER request, return the desired expires value when processing the "Expires" header.

Parameters

expires	Set this to the desired expiration value for the set of contacts that do not explicitly set the "expires" param.
returnCode	If the REGISTER should be rejected, use this return code. A value of 423 will result in the Min-Expires header added to the response.

Definition at line 26 of file RegistrationHandler.cxx.

◆ onAdd()

virtual void resip::ServerRegistrationHandler::onAdd	(	ServerRegistrationHandle	,
		const SipMessage &	reg
	)

pure virtual

Called when one or more contacts are added.

This is after authentication has all succeeded

Implemented in repro::Registrar.

◆ onQuery()

virtual void resip::ServerRegistrationHandler::onQuery	(	ServerRegistrationHandle	,
		const SipMessage &	reg
	)

pure virtual

Called when a client queries for the list of current registrations.

Implemented in repro::Registrar.

◆ onRefresh()

virtual void resip::ServerRegistrationHandler::onRefresh	(	ServerRegistrationHandle	,
		const SipMessage &	reg
	)

pure virtual

Called when registration is refreshed.

Implemented in repro::Registrar.

◆ onRemove()

virtual void resip::ServerRegistrationHandler::onRemove	(	ServerRegistrationHandle	,
		const SipMessage &	reg
	)

pure virtual

called when one or more specified contacts is removed

Implemented in repro::Registrar.

◆ onRemoveAll()

virtual void resip::ServerRegistrationHandler::onRemoveAll	(	ServerRegistrationHandle	,
		const SipMessage &	reg
	)

pure virtual

Called when all the contacts are removed using "Contact: *".

Implemented in repro::Registrar.

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

resip/dum/RegistrationHandler.hxx
resip/dum/RegistrationHandler.cxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ServerRegistrationHandler()

Member Function Documentation

◆ asyncGetContacts()

◆ asyncProcessing()

◆ asyncRemoveExpired()

◆ asyncUpdateContacts()

◆ getContactExpires()

◆ getGlobalExpires()

◆ onAdd()

◆ onQuery()

◆ onRefresh()

◆ onRemove()

◆ onRemoveAll()