reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
Public Member Functions | List of all members
resip::ServerSubscriptionHandler Class Referenceabstract

#include <SubscriptionHandler.hxx>

Inheritance diagram for resip::ServerSubscriptionHandler:
[legend]

Public Member Functions

virtual ~ServerSubscriptionHandler ()
 
virtual void onNewSubscription (ServerSubscriptionHandle, const SipMessage &sub)=0
 
virtual void onNewSubscriptionFromRefer (ServerSubscriptionHandle, const SipMessage &sub)
 
virtual void onRefresh (ServerSubscriptionHandle, const SipMessage &sub)
 
virtual void onPublished (ServerSubscriptionHandle associated, ServerPublicationHandle publication, const Contents *contents, const SecurityAttributes *attrs)
 
virtual void onNotifyAccepted (ServerSubscriptionHandle, const SipMessage &msg)
 
virtual void onNotifyRejected (ServerSubscriptionHandle, const SipMessage &msg)
 
virtual void onTerminated (ServerSubscriptionHandle)=0
 
virtual void onReadyToSend (ServerSubscriptionHandle, SipMessage &msg)
 
virtual void onError (ServerSubscriptionHandle, const SipMessage &msg)
 
virtual void onExpiredByClient (ServerSubscriptionHandle, const SipMessage &sub, SipMessage &notify)
 
virtual void onExpired (ServerSubscriptionHandle, SipMessage &notify)
 
virtual void onFlowTerminated (ServerSubscriptionHandle)
 Called when a TCP or TLS flow to the server has terminated.
 
virtual void getExpires (const SipMessage &msg, uint32_t &expires, int &errorResponseCode)
 Default behavior is to use the expires value in the SipMessage, if it exists.
 
virtual bool hasDefaultExpires () const
 dcm! – a bit clunky, but really want these objects to not have state
 
virtual uint32_t getDefaultExpires () const
 
virtual bool hasMinExpires () const
 
virtual uint32_t getMinExpires () const
 
virtual bool hasMaxExpires () const
 
virtual uint32_t getMaxExpires () const
 
const Mimes & getSupportedMimeTypes () const
 

Detailed Description

Definition at line 43 of file SubscriptionHandler.hxx.

Constructor & Destructor Documentation

◆ ~ServerSubscriptionHandler()

virtual resip::ServerSubscriptionHandler::~ServerSubscriptionHandler ( )
inlinevirtual

Definition at line 46 of file SubscriptionHandler.hxx.

Member Function Documentation

◆ getDefaultExpires()

uint32_t ServerSubscriptionHandler::getDefaultExpires ( ) const
virtual

Reimplemented in resip::DefaultServerReferHandler, and recon::ConversationManager.

Definition at line 63 of file SubscriptionHandler.cxx.

◆ getExpires()

void ServerSubscriptionHandler::getExpires ( const SipMessage &  msg,
uint32_t &  expires,
int &  errorResponseCode 
)
virtual

Default behavior is to use the expires value in the SipMessage, if it exists.

Then verify the expires >= Min and <= Max (if set). If an expires value does not exists, use getDefaultExpires(). If hasDefaultExpires() is false, then reject the message with a 400. Set errorReturnCode to an error code >= 400 to reject this subscription.

Definition at line 92 of file SubscriptionHandler.cxx.

◆ getMaxExpires()

uint32_t ServerSubscriptionHandler::getMaxExpires ( ) const
virtual

Definition at line 86 of file SubscriptionHandler.cxx.

◆ getMinExpires()

uint32_t ServerSubscriptionHandler::getMinExpires ( ) const
virtual

Definition at line 75 of file SubscriptionHandler.cxx.

◆ getSupportedMimeTypes()

const Mimes & ServerSubscriptionHandler::getSupportedMimeTypes ( ) const

Definition at line 35 of file SubscriptionHandler.cxx.

◆ hasDefaultExpires()

bool ServerSubscriptionHandler::hasDefaultExpires ( ) const
virtual

dcm! – a bit clunky, but really want these objects to not have state

Reimplemented in resip::DefaultServerReferHandler, and recon::ConversationManager.

Definition at line 57 of file SubscriptionHandler.cxx.

◆ hasMaxExpires()

bool ServerSubscriptionHandler::hasMaxExpires ( ) const
virtual

Definition at line 80 of file SubscriptionHandler.cxx.

◆ hasMinExpires()

bool ServerSubscriptionHandler::hasMinExpires ( ) const
virtual

Definition at line 69 of file SubscriptionHandler.cxx.

◆ onError()

void ServerSubscriptionHandler::onError ( ServerSubscriptionHandle  ,
const SipMessage &  msg 
)
virtual

Reimplemented in repro::CertSubscriptionHandler, repro::PresenceSubscriptionHandler, repro::PrivateKeySubscriptionHandler, and recon::ConversationManager.

Definition at line 41 of file SubscriptionHandler.cxx.

◆ onExpired()

void ServerSubscriptionHandler::onExpired ( ServerSubscriptionHandle  ,
SipMessage &  notify 
)
virtual

Reimplemented in recon::ConversationManager.

Definition at line 51 of file SubscriptionHandler.cxx.

◆ onExpiredByClient()

void ServerSubscriptionHandler::onExpiredByClient ( ServerSubscriptionHandle  ,
const SipMessage &  sub,
SipMessage &  notify 
)
virtual

Reimplemented in recon::ConversationManager.

Definition at line 46 of file SubscriptionHandler.cxx.

◆ onFlowTerminated()

void ServerSubscriptionHandler::onFlowTerminated ( ServerSubscriptionHandle  h)
virtual

Called when a TCP or TLS flow to the server has terminated.

This can be caused by socket errors, or missing CRLF keep alives pong responses from the server. supports RFC5626 (outbound). Default implementation is to tear down the subscription

Definition at line 158 of file SubscriptionHandler.cxx.

◆ onNewSubscription()

virtual void resip::ServerSubscriptionHandler::onNewSubscription ( ServerSubscriptionHandle  ,
const SipMessage &  sub 
)
pure virtual

Implemented in repro::CertSubscriptionHandler, repro::PresenceSubscriptionHandler, repro::PrivateKeySubscriptionHandler, recon::ConversationManager, and resip::DefaultServerReferHandler.

◆ onNewSubscriptionFromRefer()

void ServerSubscriptionHandler::onNewSubscriptionFromRefer ( ServerSubscriptionHandle  ,
const SipMessage &  sub 
)
virtual

Reimplemented in recon::ConversationManager, and resip::DefaultServerReferHandler.

Definition at line 153 of file SubscriptionHandler.cxx.

◆ onNotifyAccepted()

void ServerSubscriptionHandler::onNotifyAccepted ( ServerSubscriptionHandle  h,
const SipMessage &  msg 
)
virtual

Definition at line 137 of file SubscriptionHandler.cxx.

◆ onNotifyRejected()

void ServerSubscriptionHandler::onNotifyRejected ( ServerSubscriptionHandle  h,
const SipMessage &  msg 
)
virtual

Reimplemented in recon::ConversationManager.

Definition at line 142 of file SubscriptionHandler.cxx.

◆ onPublished()

void ServerSubscriptionHandler::onPublished ( ServerSubscriptionHandle  associated,
ServerPublicationHandle  publication,
const Contents *  contents,
const SecurityAttributes *  attrs 
)
virtual

Reimplemented in repro::CertSubscriptionHandler, repro::PresenceSubscriptionHandler, and repro::PrivateKeySubscriptionHandler.

Definition at line 128 of file SubscriptionHandler.cxx.

◆ onReadyToSend()

void ServerSubscriptionHandler::onReadyToSend ( ServerSubscriptionHandle  h,
SipMessage &  msg 
)
virtual

Reimplemented in recon::ConversationManager, and resip::DefaultServerReferHandler.

Definition at line 147 of file SubscriptionHandler.cxx.

◆ onRefresh()

void ServerSubscriptionHandler::onRefresh ( ServerSubscriptionHandle  handle,
const SipMessage &  sub 
)
virtual

Reimplemented in repro::PresenceSubscriptionHandler, recon::ConversationManager, and resip::DefaultServerReferHandler.

Definition at line 121 of file SubscriptionHandler.cxx.

◆ onTerminated()

virtual void resip::ServerSubscriptionHandler::onTerminated ( ServerSubscriptionHandle  )
pure virtual

Implemented in repro::CertSubscriptionHandler, repro::PresenceSubscriptionHandler, repro::PrivateKeySubscriptionHandler, recon::ConversationManager, and resip::DefaultServerReferHandler.

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