reSIProcate/DialogUsageManager  9694
Public Member Functions
resip::TestInviteSessionHandler Class Reference

#include <TestDumHandlers.hxx>

Inheritance diagram for resip::TestInviteSessionHandler:
Inheritance graph
[legend]
Collaboration diagram for resip::TestInviteSessionHandler:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 TestInviteSessionHandler ()
virtual ~TestInviteSessionHandler ()
virtual void onNewSession (ClientInviteSessionHandle, InviteSession::OfferAnswerType oat, const SipMessage &msg)
 called when an initial INVITE or the intial response to an outoing invite
virtual void onFailure (ClientInviteSessionHandle, const SipMessage &msg)
 Received a failure response from UAS.
virtual void onProvisional (ClientInviteSessionHandle, const SipMessage &msg)
 called when dialog enters the Early state - typically after getting 18x
virtual void onConnected (ClientInviteSessionHandle, const SipMessage &msg)
 called when a dialog initiated as a UAC enters the connected state
virtual void onStaleCallTimeout (ClientInviteSessionHandle)
 UAC gets no final response within the stale call timeout (default is 3 minutes).
virtual void onRedirected (ClientInviteSessionHandle, const SipMessage &msg)
 called when a 3xx with valid targets is encountered in an early dialog This is different then getting a 3xx in onTerminated, as another request will be attempted, so the DialogSet will not be destroyed.
virtual void onEarlyMedia (ClientInviteSessionHandle, const SipMessage &msg, const SdpContents &sdp)
 called when an in-dialog provisional response is received that contains a body
virtual void onForkDestroyed (ClientInviteSessionHandle)
 called when a fork that was created through a 1xx never receives a 2xx because another fork answered and this fork was canceled by a proxy.
virtual void onNewSession (ServerInviteSessionHandle is, InviteSession::OfferAnswerType oat, const SipMessage &msg)
 called when an initial INVITE or the intial response to an outoing invite
virtual void onConnected (InviteSessionHandle, const SipMessage &msg)
 called when a dialog initiated as a UAS enters the connected state
virtual void onTerminated (InviteSessionHandle, InviteSessionHandler::TerminatedReason reason, const SipMessage *msg)
virtual void onOffer (InviteSessionHandle is, const SipMessage &msg, const SdpContents &sdp)
 called when an offer is received - must send an answer soon after this
virtual void onOfferRequired (InviteSessionHandle, const SipMessage &msg)
 called when an Invite w/out offer is sent, or any other context which requires an offer from the user
virtual void onOfferRejected (InviteSessionHandle, const SipMessage *msg)
 called if an offer in a UPDATE or re-INVITE was rejected - not real useful.
virtual void onAnswer (InviteSessionHandle, const SipMessage &msg, const SdpContents &sdp)
 called when an answer is received - has nothing to do with user answering the call
virtual void onRefer (InviteSessionHandle, ServerSubscriptionHandle, const SipMessage &msg)
 called when an REFER message is received.
virtual void onReferAccepted (InviteSessionHandle, ClientSubscriptionHandle, const SipMessage &msg)
 called when an REFER message receives an accepted response
virtual void onReferRejected (InviteSessionHandle, const SipMessage &msg)
 called when an REFER message receives a failure response
virtual void onInfo (InviteSessionHandle, const SipMessage &msg)
 called when INFO message is received
virtual void onInfoSuccess (InviteSessionHandle, const SipMessage &msg)
 called when response to INFO message is received
virtual void onInfoFailure (InviteSessionHandle, const SipMessage &msg)
virtual void onMessage (InviteSessionHandle, const SipMessage &msg)
 called when MESSAGE message is received
virtual void onMessageSuccess (InviteSessionHandle, const SipMessage &msg)
 called when response to MESSAGE message is received
virtual void onMessageFailure (InviteSessionHandle, const SipMessage &msg)

Detailed Description

Definition at line 56 of file TestDumHandlers.hxx.


Constructor & Destructor Documentation

resip::TestInviteSessionHandler::TestInviteSessionHandler ( ) [inline]

Definition at line 59 of file TestDumHandlers.hxx.

      {
      }
virtual resip::TestInviteSessionHandler::~TestInviteSessionHandler ( ) [inline, virtual]

Definition at line 63 of file TestDumHandlers.hxx.

      {
      }

Member Function Documentation

virtual void resip::TestInviteSessionHandler::onAnswer ( InviteSessionHandle  ,
const SipMessage msg,
const SdpContents  
) [inline, virtual]

called when an answer is received - has nothing to do with user answering the call

Implements resip::InviteSessionHandler.

Reimplemented in TestSMIMEInviteHandler.

Definition at line 153 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onAnswer");
      }
virtual void resip::TestInviteSessionHandler::onConnected ( ClientInviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when a dialog initiated as a UAC enters the connected state

Implements resip::InviteSessionHandler.

Reimplemented in TestUac, and TestSMIMEInviteHandler.

Definition at line 86 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onConnected" );
      }
virtual void resip::TestInviteSessionHandler::onConnected ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when a dialog initiated as a UAS enters the connected state

Implements resip::InviteSessionHandler.

Reimplemented in TestUas, and TestSMIMEInviteHandler.

Definition at line 123 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onConnected()" );
      }
virtual void resip::TestInviteSessionHandler::onEarlyMedia ( ClientInviteSessionHandle  ,
const SipMessage ,
const SdpContents  
) [inline, virtual]

called when an in-dialog provisional response is received that contains a body

Implements resip::InviteSessionHandler.

Definition at line 103 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onEarlyMedia" );
      }
virtual void resip::TestInviteSessionHandler::onFailure ( ClientInviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

Received a failure response from UAS.

Implements resip::InviteSessionHandler.

Reimplemented in TestSMIMEInviteHandler.

Definition at line 74 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHander::onFailure" );
      }
virtual void resip::TestInviteSessionHandler::onForkDestroyed ( ClientInviteSessionHandle  ) [inline, virtual]

called when a fork that was created through a 1xx never receives a 2xx because another fork answered and this fork was canceled by a proxy.

Implements resip::InviteSessionHandler.

Definition at line 110 of file TestDumHandlers.hxx.

References InfoLog.

          {
         InfoLog( << "TestInviteSessionHandler::onForkDestroyed" );
          }
virtual void resip::TestInviteSessionHandler::onInfo ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when INFO message is received

Implements resip::InviteSessionHandler.

Reimplemented in TestUac.

Definition at line 180 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onInfo" );
      }
virtual void resip::TestInviteSessionHandler::onInfoFailure ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

Implements resip::InviteSessionHandler.

Definition at line 192 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onInfoFailure" );
      }
virtual void resip::TestInviteSessionHandler::onInfoSuccess ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when response to INFO message is received

Implements resip::InviteSessionHandler.

Reimplemented in TestUas.

Definition at line 186 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onInfoSuccess" );
      }
virtual void resip::TestInviteSessionHandler::onMessage ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when MESSAGE message is received

Implements resip::InviteSessionHandler.

Reimplemented in TestUas.

Definition at line 198 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onMessage" );
      }
virtual void resip::TestInviteSessionHandler::onMessageFailure ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

Implements resip::InviteSessionHandler.

Definition at line 210 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onMessageFailure" );
      }
virtual void resip::TestInviteSessionHandler::onMessageSuccess ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when response to MESSAGE message is received

Implements resip::InviteSessionHandler.

Reimplemented in TestUac.

Definition at line 204 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onMessageSuccess" );
      }
virtual void resip::TestInviteSessionHandler::onNewSession ( ClientInviteSessionHandle  ,
InviteSession::OfferAnswerType  oat,
const SipMessage msg 
) [inline, virtual]

called when an initial INVITE or the intial response to an outoing invite

Implements resip::InviteSessionHandler.

Reimplemented in TestUas, and TestSMIMEInviteHandler.

Definition at line 67 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onNewSession" );
      }
virtual void resip::TestInviteSessionHandler::onNewSession ( ServerInviteSessionHandle  ,
InviteSession::OfferAnswerType  oat,
const SipMessage msg 
) [inline, virtual]

called when an initial INVITE or the intial response to an outoing invite

Implements resip::InviteSessionHandler.

Reimplemented in TestUas, and TestSMIMEInviteHandler.

Definition at line 115 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onNewSession" );
//         is->provisional(180);
      }
virtual void resip::TestInviteSessionHandler::onOffer ( InviteSessionHandle  ,
const SipMessage msg,
const SdpContents  
) [inline, virtual]

called when an offer is received - must send an answer soon after this

Implements resip::InviteSessionHandler.

Reimplemented in TestUas, TestUac, and TestSMIMEInviteHandler.

Definition at line 135 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onOffer");
      }
virtual void resip::TestInviteSessionHandler::onOfferRejected ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called if an offer in a UPDATE or re-INVITE was rejected - not real useful.

A SipMessage is provided if one is available

Implements resip::InviteSessionHandler.

Definition at line 147 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onOfferRejected" );
      }
virtual void resip::TestInviteSessionHandler::onOfferRequired ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when an Invite w/out offer is sent, or any other context which requires an offer from the user

Implements resip::InviteSessionHandler.

Reimplemented in TestUas.

Definition at line 141 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onOfferRequired" );
      }
virtual void resip::TestInviteSessionHandler::onProvisional ( ClientInviteSessionHandle  ,
const SipMessage  
) [inline, virtual]

called when dialog enters the Early state - typically after getting 18x

Implements resip::InviteSessionHandler.

Definition at line 80 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onProvisional" );
      }
virtual void resip::TestInviteSessionHandler::onRedirected ( ClientInviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when a 3xx with valid targets is encountered in an early dialog This is different then getting a 3xx in onTerminated, as another request will be attempted, so the DialogSet will not be destroyed.

Basically an onTermintated that conveys more information. checking for 3xx respones in onTerminated will not work as there may be no valid targets.

Implements resip::InviteSessionHandler.

Definition at line 97 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onRedirected");
      }
virtual void resip::TestInviteSessionHandler::onRefer ( InviteSessionHandle  ,
ServerSubscriptionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when an REFER message is received.

The refer is accepted or rejected using the server subscription. If the offer is accepted, DialogUsageManager::makeInviteSessionFromRefer can be used to create an InviteSession that will send notify messages using the ServerSubscription

Implements resip::InviteSessionHandler.

Definition at line 160 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onRefer" );
      }
virtual void resip::TestInviteSessionHandler::onReferAccepted ( InviteSessionHandle  ,
ClientSubscriptionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when an REFER message receives an accepted response

Implements resip::InviteSessionHandler.

Definition at line 167 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onReferAccepted" );
      }
virtual void resip::TestInviteSessionHandler::onReferRejected ( InviteSessionHandle  ,
const SipMessage msg 
) [inline, virtual]

called when an REFER message receives a failure response

Implements resip::InviteSessionHandler.

Definition at line 174 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onReferRejected" );
      }
virtual void resip::TestInviteSessionHandler::onStaleCallTimeout ( ClientInviteSessionHandle  h) [inline, virtual]

UAC gets no final response within the stale call timeout (default is 3 minutes).

This is just a notification. After the notification is called, the InviteSession will then call InviteSessionHandler::terminate()

Reimplemented from resip::InviteSessionHandler.

Definition at line 92 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onStaleCallTimeout" );
      }
virtual void resip::TestInviteSessionHandler::onTerminated ( InviteSessionHandle  ,
InviteSessionHandler::TerminatedReason  reason,
const SipMessage msg 
) [inline, virtual]

Implements resip::InviteSessionHandler.

Reimplemented in TestUas, TestUac, and TestSMIMEInviteHandler.

Definition at line 128 of file TestDumHandlers.hxx.

References InfoLog.

      {
         InfoLog( << "TestInviteSessionHandler::onTerminated");
      }

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