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

#include <RegistrationHandler.hxx>

Inheritance diagram for resip::ClientRegistrationHandler:
[legend]

Public Member Functions

virtual ~ClientRegistrationHandler ()
 
virtual void onSuccess (ClientRegistrationHandle, const SipMessage &response)=0
 Called when registration succeeds or each time it is successfully refreshed (manual refreshes only).
 
virtual void onRemoved (ClientRegistrationHandle, const SipMessage &response)=0
 
virtual int onRequestRetry (ClientRegistrationHandle, int retrySeconds, const SipMessage &response)=0
 call on Retry-After failure.
 
virtual void onFailure (ClientRegistrationHandle, const SipMessage &response)=0
 Called if registration fails, usage will be destroyed (unless a Registration retry interval is enabled in the Profile)
 
virtual void onFlowTerminated (ClientRegistrationHandle)
 Called when a TCP or TLS flow to the server has terminated.
 
virtual bool onRefreshRequired (ClientRegistrationHandle, const SipMessage &lastRequest)
 Called before attempting to refresh a registration Return true if the refresh should go ahead or false otherwise Default implementation always returns true.
 

Detailed Description

Definition at line 16 of file RegistrationHandler.hxx.

Constructor & Destructor Documentation

◆ ~ClientRegistrationHandler()

virtual resip::ClientRegistrationHandler::~ClientRegistrationHandler ( )
inlinevirtual

Definition at line 19 of file RegistrationHandler.hxx.

Member Function Documentation

◆ onFailure()

virtual void resip::ClientRegistrationHandler::onFailure ( ClientRegistrationHandle  ,
const SipMessage &  response 
)
pure virtual

Called if registration fails, usage will be destroyed (unless a Registration retry interval is enabled in the Profile)

Implemented in recon::UserAgent.

◆ onFlowTerminated()

void ClientRegistrationHandler::onFlowTerminated ( ClientRegistrationHandle  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 immediately re-Register in an attempt to form a new flow.

Definition at line 12 of file RegistrationHandler.cxx.

◆ onRefreshRequired()

bool ClientRegistrationHandler::onRefreshRequired ( ClientRegistrationHandle  h,
const SipMessage &  lastRequest 
)
virtual

Called before attempting to refresh a registration Return true if the refresh should go ahead or false otherwise Default implementation always returns true.

Definition at line 19 of file RegistrationHandler.cxx.

◆ onRemoved()

virtual void resip::ClientRegistrationHandler::onRemoved ( ClientRegistrationHandle  ,
const SipMessage &  response 
)
pure virtual

Implemented in recon::UserAgent.

◆ onRequestRetry()

virtual int resip::ClientRegistrationHandler::onRequestRetry ( ClientRegistrationHandle  ,
int  retrySeconds,
const SipMessage &  response 
)
pure virtual

call on Retry-After failure.

return values: -1 = fail, 0 = retry immediately, N = retry in N seconds

Implemented in recon::UserAgent.

◆ onSuccess()

virtual void resip::ClientRegistrationHandler::onSuccess ( ClientRegistrationHandle  ,
const SipMessage &  response 
)
pure virtual

Called when registration succeeds or each time it is successfully refreshed (manual refreshes only).


Implemented in recon::UserAgent.

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