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

dcm! – no Subscription State expires parameter generation yet. More...

#include <ServerSubscription.hxx>

Inheritance diagram for resip::ServerSubscription:
[legend]

Public Types

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

Public Member Functions

 ServerSubscription (const ServerSubscription &)=delete
 
 ServerSubscription (ServerSubscription &&)=delete
 
ServerSubscription & operator= (const ServerSubscription &)=delete
 
ServerSubscription & operator= (ServerSubscription &&)=delete
 
ServerSubscriptionHandle getHandle () const
 
const Data & getSubscriber () const noexcept
 
uint32_t getTimeLeft ()
 
std::shared_ptr< SipMessage > accept (int statusCode=202)
 
std::shared_ptr< SipMessage > reject (int responseCode)
 
bool isResponsePending ()
 
std::shared_ptr< SipMessage > neutralNotify ()
 
void setSubscriptionState (SubscriptionState state)
 
std::shared_ptr< SipMessage > update (const Contents *document)
 
void end (TerminateReason reason, const Contents *document=0, int retryAfter=0)
 
void end () override
 
void send (std::shared_ptr< SipMessage > msg) override
 
void sendCommand (std::shared_ptr< SipMessage > msg) override
 
void dispatch (const SipMessage &msg) override
 
void dispatch (const DumTimeout &timer) override
 
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 ~ServerSubscription ()
 
virtual void onReadyToSend (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
 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
 

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! – no Subscription State expires parameter generation yet.

Definition at line 14 of file ServerSubscription.hxx.

Member Typedef Documentation

◆ ServerSubscriptionHandle

typedef Handle<ServerSubscription> resip::ServerSubscription::ServerSubscriptionHandle

Definition at line 17 of file ServerSubscription.hxx.

Constructor & Destructor Documentation

◆ ServerSubscription() [1/2]

resip::ServerSubscription::ServerSubscription ( const ServerSubscription &  )
delete

◆ ServerSubscription() [2/2]

resip::ServerSubscription::ServerSubscription ( ServerSubscription &&  )
delete

◆ ~ServerSubscription()

ServerSubscription::~ServerSubscription ( )
protectedvirtual

Definition at line 40 of file ServerSubscription.cxx.

Member Function Documentation

◆ accept()

std::shared_ptr< SipMessage > ServerSubscription::accept ( int  statusCode = 202)

Definition at line 75 of file ServerSubscription.cxx.

◆ dispatch() [1/2]

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

Implements resip::BaseUsage.

Definition at line 430 of file ServerSubscription.cxx.

◆ dispatch() [2/2]

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

dcm! – need to have a mechanism to retrieve default & acceptable

dcm! – should initial state be pending?

Implements resip::BaseUsage.

Definition at line 224 of file ServerSubscription.cxx.

◆ dump()

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

Implements resip::BaseUsage.

Definition at line 477 of file ServerSubscription.cxx.

◆ end() [1/2]

void ServerSubscription::end ( )
overridevirtual

Implements resip::BaseUsage.

Definition at line 424 of file ServerSubscription.cxx.

◆ end() [2/2]

void ServerSubscription::end ( TerminateReason  reason,
const Contents *  document = 0,
int  retryAfter = 0 
)

Definition at line 404 of file ServerSubscription.cxx.

◆ flowTerminated()

void ServerSubscription::flowTerminated ( )
protectedvirtual

Definition at line 468 of file ServerSubscription.cxx.

◆ getHandle()

ServerSubscriptionHandle ServerSubscription::getHandle ( ) const

Definition at line 18 of file ServerSubscription.cxx.

◆ getSubscriber()

const Data & resip::ServerSubscription::getSubscriber ( ) const
inlinenoexcept

Definition at line 27 of file ServerSubscription.hxx.

◆ getTimeLeft()

uint32_t ServerSubscription::getTimeLeft ( )

Definition at line 61 of file ServerSubscription.cxx.

◆ isResponsePending()

bool resip::ServerSubscription::isResponsePending ( )
inline

Definition at line 34 of file ServerSubscription.hxx.

◆ neutralNotify()

std::shared_ptr< SipMessage > ServerSubscription::neutralNotify ( )

Definition at line 452 of file ServerSubscription.cxx.

◆ onReadyToSend()

void ServerSubscription::onReadyToSend ( SipMessage &  msg)
overrideprotectedvirtual

Reimplemented from resip::DialogUsage.

Definition at line 460 of file ServerSubscription.cxx.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ reject()

std::shared_ptr< SipMessage > ServerSubscription::reject ( int  responseCode)

Definition at line 89 of file ServerSubscription.cxx.

◆ send()

void ServerSubscription::send ( std::shared_ptr< SipMessage >  msg)
overridevirtual

Reimplemented from resip::DialogUsage.

Definition at line 113 of file ServerSubscription.cxx.

◆ sendCommand()

void resip::ServerSubscription::sendCommand ( std::shared_ptr< SipMessage >  msg)
inlineoverridevirtual

Reimplemented from resip::DialogUsage.

Definition at line 48 of file ServerSubscription.hxx.

◆ setSubscriptionState()

void ServerSubscription::setSubscriptionState ( SubscriptionState  state)

Definition at line 214 of file ServerSubscription.cxx.

◆ update()

std::shared_ptr< SipMessage > ServerSubscription::update ( const Contents *  document)

Definition at line 444 of file ServerSubscription.cxx.

Friends And Related Symbol Documentation

◆ Dialog

friend class Dialog
friend

Definition at line 67 of file ServerSubscription.hxx.

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