InviteSessionHandler.hxx

Go to the documentation of this file.

#if !defined(RESIP_INVITESESSIONHANDLER_HXX)
#define RESIP_INVITESESSIONHANDLER_HXX

#include "resip/dum/InviteSession.hxx"
#include "resip/dum/Handles.hxx"

namespace resip
{

class SipMessage;
class SdpContents;
class Contents;

class InviteSessionHandler
{
   public:
      InviteSessionHandler(bool genericOfferAnswer=false) : mGenericOfferAnswer(genericOfferAnswer) {}
      virtual ~InviteSessionHandler() {}
      virtual bool isGenericOfferAnswer() { return mGenericOfferAnswer; }

      virtual void onNewSession(ClientInviteSessionHandle, InviteSession::OfferAnswerType oat, const SipMessage& msg)=0;
      virtual void onNewSession(ServerInviteSessionHandle, InviteSession::OfferAnswerType oat, const SipMessage& msg)=0;

      virtual void onFailure(ClientInviteSessionHandle, const SipMessage& msg)=0;
      
      virtual void onEarlyMedia(ClientInviteSessionHandle, const SipMessage&, const SdpContents&)=0;
      virtual void onEarlyMedia(ClientInviteSessionHandle, const SipMessage&, const Contents&);

      virtual void onProvisional(ClientInviteSessionHandle, const SipMessage&)=0;

      virtual void onConnected(ClientInviteSessionHandle, const SipMessage& msg)=0;

      virtual void onConnected(InviteSessionHandle, const SipMessage& msg)=0;

      virtual void onConnectedConfirmed(InviteSessionHandle, const SipMessage &msg);

      virtual void onStaleCallTimeout(ClientInviteSessionHandle h);

      virtual void terminate(ClientInviteSessionHandle h);
      
      enum TerminatedReason
      {
         Error,
         Timeout, 
         Replaced,
         LocalBye,
         RemoteBye,
         LocalCancel,
         RemoteCancel,
         Rejected, //Only as UAS, UAC has distinct onFailure callback
         Referred
      };
            
      virtual void onTerminated(InviteSessionHandle, InviteSessionHandler::TerminatedReason reason, const SipMessage* related=0)=0;

      virtual void onForkDestroyed(ClientInviteSessionHandle)=0;

      virtual void onRedirected(ClientInviteSessionHandle, const SipMessage& msg)=0;

      virtual void onReadyToSend(InviteSessionHandle, SipMessage& msg);

      virtual void onAnswer(InviteSessionHandle, const SipMessage& msg, const SdpContents&)=0;
      // You should only override the following method if genericOfferAnswer is true
      virtual void onAnswer(InviteSessionHandle, const SipMessage& msg, const Contents&);

      virtual void onOffer(InviteSessionHandle, const SipMessage& msg, const SdpContents&)=0;      
      // You should only override the following method if genericOfferAnswer is true
      virtual void onOffer(InviteSessionHandle, const SipMessage& msg, const Contents&);      

      virtual void onRemoteSdpChanged(InviteSessionHandle, const SipMessage& msg, const SdpContents&);
      // You should only override the following method if genericOfferAnswer is true
      virtual void onRemoteAnswerChanged(InviteSessionHandle, const SipMessage& msg, const Contents&);  

      virtual void onOfferRequestRejected(InviteSessionHandle, const SipMessage& msg);

      virtual void onOfferRequired(InviteSessionHandle, const SipMessage& msg)=0;      
      
      virtual void onOfferRejected(InviteSessionHandle, const SipMessage* msg)=0;
      
      virtual void onInfo(InviteSessionHandle, const SipMessage& msg)=0;

      virtual void onInfoSuccess(InviteSessionHandle, const SipMessage& msg)=0;
      virtual void onInfoFailure(InviteSessionHandle, const SipMessage& msg)=0;

      virtual void onMessage(InviteSessionHandle, const SipMessage& msg)=0;

      virtual void onMessageSuccess(InviteSessionHandle, const SipMessage& msg)=0;
      virtual void onMessageFailure(InviteSessionHandle, const SipMessage& msg)=0;

      virtual void onRefer(InviteSessionHandle, ServerSubscriptionHandle, const SipMessage& msg)=0;

      virtual void onReferNoSub(InviteSessionHandle, const SipMessage& msg)=0;

      virtual void onReferRejected(InviteSessionHandle, const SipMessage& msg)=0;

      virtual void onReferAccepted(InviteSessionHandle, ClientSubscriptionHandle, const SipMessage& msg)=0;

      virtual void onAckReceived(InviteSessionHandle, const SipMessage& msg);

      virtual void onAckNotReceived(InviteSessionHandle);

      virtual void onStaleReInviteTimeout(InviteSessionHandle h);

      virtual void onIllegalNegotiation(InviteSessionHandle, const SipMessage& msg);     

      virtual void onSessionExpired(InviteSessionHandle);

      //  Called only if clientOutbound is enabled on the UserProfile and the first hop server 
      virtual void onFlowTerminated(InviteSessionHandle);

   private:
          bool mGenericOfferAnswer;
};

}

#endif

/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */