reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Friends | List of all members
resip::ServerRegistration Class Reference

#include <ServerRegistration.hxx>

Inheritance diagram for resip::ServerRegistration:
[legend]

Public Member Functions

ServerRegistrationHandle getHandle ()
 
void accept (SipMessage &ok)
 Accept a SIP registration with a specific response.
 
void accept (int statusCode=200)
 Accept a SIP registration.
 
void reject (SipMessage &failure)
 Reject a SIP registration with a specific response.
 
void reject (int statusCode)
 Reject a SIP registration.
 
void end () override
 
void dispatch (const SipMessage &msg) override
 
void dispatch (const DumTimeout &timer) override
 
EncodeStream & dump (EncodeStream &strm) const override
 
bool asyncProvideContacts (std::unique_ptr< resip::ContactPtrList > contacts)
 Used when useAsyncProcessing() is true.
 
std::shared_ptr< ContactList > getOriginalContacts () const noexcept
 
const ContactList & getRequestContacts () const noexcept
 
- 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 ()
 

Protected Member Functions

virtual ~ServerRegistration ()
 
- 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

Definition at line 14 of file ServerRegistration.hxx.

Constructor & Destructor Documentation

◆ ~ServerRegistration()

ServerRegistration::~ServerRegistration ( )
protectedvirtual

Definition at line 34 of file ServerRegistration.cxx.

Member Function Documentation

◆ accept() [1/2]

void ServerRegistration::accept ( int  statusCode = 200)

Accept a SIP registration.

!Warning! After calling this function from a ServerRegistrationHandle, do not access the handle as this function may delete this object. Use ServerRegistrationHandle::isValidHandle() to test if it's deleted.

Definition at line 132 of file ServerRegistration.cxx.

◆ accept() [2/2]

void ServerRegistration::accept ( SipMessage &  ok)

Accept a SIP registration with a specific response.

Any contacts in this message will be deleted and replaced with the list created during REGISTER processing.

!Warning! After calling this function from a ServerRegistrationHandle, do not access the handle as this function may delete this object. Use ServerRegistrationHandle::isValidHandle() to test if it's deleted.

WARN! Must not access this object beyond this point. The client my call reject() or accept(), deleting this object. Also, watch out for local objects that are still in scope and access this object on destruction.

Definition at line 46 of file ServerRegistration.cxx.

◆ asyncProvideContacts()

bool ServerRegistration::asyncProvideContacts ( std::unique_ptr< resip::ContactPtrList >  contacts)

Used when useAsyncProcessing() is true.

Provide the current set of contacts for this registration for processing. This is required during initial registration processing to provide a local copy of the registered contacts, which are then updated by the registration processing. At the end of the registration processing this function must provide a final list of contacts after any user-defined manipulation.

!CAUTION! This function must be called from the DUM thread.

Definition at line 699 of file ServerRegistration.cxx.

◆ dispatch() [1/2]

void ServerRegistration::dispatch ( const DumTimeout &  timer)
overridevirtual

Implements resip::BaseUsage.

Definition at line 456 of file ServerRegistration.cxx.

◆ dispatch() [2/2]

void ServerRegistration::dispatch ( const SipMessage &  msg)
overridevirtual

WARN! Must not access this object beyond this point. The client my call reject() or accept(), deleting this object. Also, watch out for local objects that are still in scope and access this object on destruction.

Implements resip::BaseUsage.

Definition at line 188 of file ServerRegistration.cxx.

◆ dump()

EncodeStream & ServerRegistration::dump ( EncodeStream &  strm) const
overridevirtual

Implements resip::BaseUsage.

Definition at line 461 of file ServerRegistration.cxx.

◆ end()

void ServerRegistration::end ( )
overridevirtual

Implements resip::BaseUsage.

Definition at line 40 of file ServerRegistration.cxx.

◆ getHandle()

ServerRegistrationHandle ServerRegistration::getHandle ( )

Definition at line 22 of file ServerRegistration.cxx.

◆ getOriginalContacts()

std::shared_ptr< ContactList > resip::ServerRegistration::getOriginalContacts ( ) const
inlinenoexcept

Definition at line 62 of file ServerRegistration.hxx.

◆ getRequestContacts()

const ContactList & resip::ServerRegistration::getRequestContacts ( ) const
inlinenoexcept

Definition at line 63 of file ServerRegistration.hxx.

◆ reject() [1/2]

void ServerRegistration::reject ( int  statusCode)

Reject a SIP registration.


!Warning! After calling this function from a ServerRegistrationHandle, do not access the handle as this function may delete this object. Use ServerRegistrationHandle::isValidHandle() to test if it's deleted.

Definition at line 180 of file ServerRegistration.cxx.

◆ reject() [2/2]

void ServerRegistration::reject ( SipMessage &  failure)

Reject a SIP registration with a specific response.

Any contacts in this message will be deleted.

!Warning! After calling this function from a ServerRegistrationHandle, do not access the handle as this function may delete this object. Use ServerRegistrationHandle::isValidHandle() to test if it's deleted.

Definition at line 150 of file ServerRegistration.cxx.

Friends And Related Symbol Documentation

◆ DialogSet

friend class DialogSet
friend

Definition at line 68 of file ServerRegistration.hxx.

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