reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
resip::ClientSubscription Class Reference

dcm! – update contact in dialog if required More...

#include <ClientSubscription.hxx>

Inheritance diagram for resip::ClientSubscription:
[legend]

Public Types

typedef Handle< ClientSubscription > ClientSubscriptionHandle
 
- Public Types inherited from resip::Handled
enum  { npos = 0 }
 
typedef unsigned long Id
 

Public Member Functions

 ClientSubscription (DialogUsageManager &dum, Dialog &dialog, const SipMessage &request)
 
 ClientSubscription (const ClientSubscription &)=delete
 
 ClientSubscription (ClientSubscription &&)=delete
 
ClientSubscription & operator= (const ClientSubscription &)=delete
 
ClientSubscription & operator= (ClientSubscription &&)=delete
 
ClientSubscriptionHandle getHandle ()
 
void acceptUpdate (int statusCode=200, const char *reason=nullptr)
 
void rejectUpdate (int statusCode=400, const Data &reasonPhrase=Data::Empty)
 
void requestRefresh (uint32_t expires=0)
 
void end () override
 
void end (bool immediate)
 
virtual void reSubscribe ()
 
void acceptUpdateCommand (int statusCode=200, const char *reason=nullptr)
 Provide asynchronous method access by using command.
 
void rejectUpdateCommand (int statusCode=400, const Data &reasonPhrase=Data::Empty)
 
void requestRefreshCommand (uint32_t expires=0)
 
virtual void endCommand (bool immediate=false)
 
EncodeStream & dump (EncodeStream &strm) const override
 
- Public Member Functions inherited from resip::BaseSubscription
 BaseSubscription (const BaseSubscription &)=delete
 
 BaseSubscription (BaseSubscription &&)=delete
 
BaseSubscription & operator= (const BaseSubscription &)=delete
 
BaseSubscription & operator= (BaseSubscription &&)=delete
 
bool matches (const SipMessage &subOrNotify)
 
const Data & getDocumentKey () const noexcept
 
const Data & getEventType () const noexcept
 
const Data & getId () const noexcept
 
- Public Member Functions inherited from resip::DialogUsage
AppDialogSetHandle getAppDialogSet () const
 
AppDialogHandle getAppDialog () const
 
const NameAddr & myAddr () const noexcept
 
const NameAddr & peerAddr () const noexcept
 
const NameAddr & remoteTarget () const noexcept
 
const NameAddr & pendingRemoteTarget () const
 
const NameAddrs & getRouteSet () const noexcept
 
const DialogId & getDialogId () const
 
const Data & getCallId () const
 
std::shared_ptr< UserProfile > getUserProfile () const
 
- 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 ~ClientSubscription ()
 
virtual void onReadyToSend (SipMessage &msg) override
 
virtual void send (std::shared_ptr< SipMessage > msg) override
 
virtual void flowTerminated ()
 
- Protected Member Functions inherited from resip::BaseSubscription
 BaseSubscription (DialogUsageManager &dum, Dialog &dialog, const SipMessage &request)
 
SubscriptionState getSubscriptionState () const noexcept
 
virtual ~BaseSubscription ()=default
 
- Protected Member Functions inherited from resip::DialogUsage
virtual void sendCommand (std::shared_ptr< SipMessage > msg)
 
 DialogUsage (DialogUsageManager &dum, Dialog &dialog)
 
virtual ~DialogUsage ()
 
- Protected Member Functions inherited from resip::BaseUsage
 BaseUsage (DialogUsageManager &dum)
 
virtual ~BaseUsage ()
 
BaseUsageHandle getBaseHandle () const
 

Friends

class Dialog
 
class InviteSession
 

Additional Inherited Members

- Protected Types inherited from resip::BaseSubscription
enum  SubDlgState { SubDlgInitial , SubDlgEstablished , SubDlgTerminating }
 
- Protected Attributes inherited from resip::BaseSubscription
SubDlgState mSubDlgState
 
std::shared_ptr< SipMessage > mLastRequest
 
std::shared_ptr< SipMessage > mLastResponse
 
Data mDocumentKey
 
Data mEventType
 
Data mSubscriptionId
 
unsigned int mTimerSeq
 
SubscriptionState mSubscriptionState
 
- Protected Attributes inherited from resip::DialogUsage
Dialog & mDialog
 
- Protected Attributes inherited from resip::BaseUsage
DialogUsageManager & mDum
 
- Protected Attributes inherited from resip::Handled
HandleManager & mHam
 
Handled::Id mId
 

Detailed Description

dcm! – update contact in dialog if required

Definition at line 14 of file ClientSubscription.hxx.

Member Typedef Documentation

◆ ClientSubscriptionHandle

Constructor & Destructor Documentation

◆ ClientSubscription() [1/3]

ClientSubscription::ClientSubscription ( DialogUsageManager &  dum,
Dialog &  dialog,
const SipMessage &  request 
)

Definition at line 21 of file ClientSubscription.cxx.

◆ ClientSubscription() [2/3]

resip::ClientSubscription::ClientSubscription ( const ClientSubscription &  )
delete

◆ ClientSubscription() [3/3]

resip::ClientSubscription::ClientSubscription ( ClientSubscription &&  )
delete

◆ ~ClientSubscription()

ClientSubscription::~ClientSubscription ( )
protectedvirtual

Definition at line 46 of file ClientSubscription.cxx.

Member Function Documentation

◆ acceptUpdate()

void ClientSubscription::acceptUpdate ( int  statusCode = 200,
const char *  reason = nullptr 
)

Definition at line 651 of file ClientSubscription.cxx.

◆ acceptUpdateCommand()

void ClientSubscription::acceptUpdateCommand ( int  statusCode = 200,
const char *  reason = nullptr 
)

Provide asynchronous method access by using command.

Definition at line 701 of file ClientSubscription.cxx.

◆ dump()

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

Implements resip::BaseUsage.

Definition at line 818 of file ClientSubscription.cxx.

◆ end() [1/2]

void ClientSubscription::end ( )
overridevirtual

Implements resip::BaseUsage.

Definition at line 582 of file ClientSubscription.cxx.

◆ end() [2/2]

void ClientSubscription::end ( bool  immediate)

Definition at line 588 of file ClientSubscription.cxx.

◆ endCommand()

void ClientSubscription::endCommand ( bool  immediate = false)
virtual

Definition at line 645 of file ClientSubscription.cxx.

◆ flowTerminated()

void ClientSubscription::flowTerminated ( )
protectedvirtual

Definition at line 833 of file ClientSubscription.cxx.

◆ getHandle()

ClientSubscriptionHandle ClientSubscription::getHandle ( )

Definition at line 61 of file ClientSubscription.cxx.

◆ onReadyToSend()

void ClientSubscription::onReadyToSend ( SipMessage &  msg)
overrideprotectedvirtual

Reimplemented from resip::DialogUsage.

Definition at line 825 of file ClientSubscription.cxx.

◆ operator=() [1/2]

ClientSubscription & resip::ClientSubscription::operator= ( ClientSubscription &&  )
delete

◆ operator=() [2/2]

ClientSubscription & resip::ClientSubscription::operator= ( const ClientSubscription &  )
delete

◆ rejectUpdate()

void ClientSubscription::rejectUpdate ( int  statusCode = 400,
const Data &  reasonPhrase = Data::Empty 
)

Definition at line 736 of file ClientSubscription.cxx.

◆ rejectUpdateCommand()

void ClientSubscription::rejectUpdateCommand ( int  statusCode = 400,
const Data &  reasonPhrase = Data::Empty 
)

Definition at line 812 of file ClientSubscription.cxx.

◆ requestRefresh()

void ClientSubscription::requestRefresh ( uint32_t  expires = 0)

dcm! – need a mechanism to retrieve this for the event package...part of

Definition at line 516 of file ClientSubscription.cxx.

◆ requestRefreshCommand()

void ClientSubscription::requestRefreshCommand ( uint32_t  expires = 0)

Definition at line 576 of file ClientSubscription.cxx.

◆ reSubscribe()

void ClientSubscription::reSubscribe ( )
virtual

Definition at line 707 of file ClientSubscription.cxx.

◆ send()

void ClientSubscription::send ( std::shared_ptr< SipMessage >  msg)
overrideprotectedvirtual

Reimplemented from resip::DialogUsage.

Definition at line 718 of file ClientSubscription.cxx.

Friends And Related Symbol Documentation

◆ Dialog

friend class Dialog
friend

Definition at line 51 of file ClientSubscription.hxx.

◆ InviteSession

friend class InviteSession
friend

Definition at line 52 of file ClientSubscription.hxx.


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