ServerInviteSession.hxx

Go to the documentation of this file.

#if !defined(RESIP_SERVERINVITESESSION_HXX)
#define RESIP_SERVERINVITESESSION_HXX
 
#include "resip/dum/InviteSession.hxx"
#include "resip/stack/SipMessage.hxx"
 
#include <deque>
 
namespace resip
{
 
class ServerInviteSession: public InviteSession
{
   public:
      typedef Handle<ServerInviteSession> ServerInviteSessionHandle;
 
      ServerInviteSession(const ServerInviteSession&) = delete;
      ServerInviteSession(ServerInviteSession&&) = delete;
 
      ServerInviteSession& operator=(const ServerInviteSession&) = delete;
      ServerInviteSession& operator=(ServerInviteSession&&) = delete;
 
      ServerInviteSessionHandle getHandle();
 
      void redirect(const NameAddrs& contacts, int code=302);
 
      void provisional(int code=180, bool earlyFlag=true);
      
      virtual void provideOffer(const Contents& offer);
      virtual void provideOffer(const Contents& offer, DialogUsageManager::EncryptionLevel level, const Contents* alternative);
      virtual void provideOffer(const Contents& offer, bool sendOfferAtAccept);
      virtual void provideOffer(const Contents& offer, DialogUsageManager::EncryptionLevel level,
                                const Contents* alternative, bool sendOfferAtAccept);
 
      virtual void requestOffer();
 
      virtual void provideAnswer(const Contents& answer);
 
      virtual void end(const Data& userReason);
      virtual void end(const ParserContainer<Token>& endReasons);
      virtual void end(EndReason reason);
      virtual void end();
 
      virtual void reject(int statusCode, WarningCategory *warning = 0);
      virtual void reject(int statusCode, const Contents* contents, WarningCategory *warning = 0);
 
      void accept(int statusCode=200);
 
      void redirectCommand(const NameAddrs& contacts, int code=302);
      void provisionalCommand(int code=180, bool earlyFlag=true);
      void acceptCommand(int statusCode=200);
 
   private:
      friend class Dialog;
 
      virtual void dispatch(const SipMessage& msg);
      virtual void dispatch(const DumTimeout& timer);
 
      void dispatchStart(const SipMessage& msg);
      void dispatchOfferOrEarly(const SipMessage& msg);
      void dispatchAccepted(const SipMessage& msg);
      void dispatchWaitingToOffer(const SipMessage& msg);
      void dispatchWaitingToRequestOffer(const SipMessage& msg);
      void dispatchAcceptedWaitingAnswer(const SipMessage& msg);
      void dispatchFirstSentOfferReliable(const SipMessage& msg);
      void dispatchOfferReliableProvidedAnswer(const SipMessage& msg);
      void dispatchFirstSentAnswerReliable(const SipMessage& msg);
      void dispatchNoAnswerReliableWaitingPrack(const SipMessage& msg);
      void dispatchSentUpdate(const SipMessage& msg);
      void dispatchSentUpdateGlare(const SipMessage& msg);
      void dispatchSentUpdateAccepted(const SipMessage& msg);
      void dispatchReceivedUpdate(const SipMessage& msg);
      void dispatchReceivedUpdateWaitingAnswer(const SipMessage& msg);
      void dispatchWaitingToHangup(const SipMessage& msg);
      void dispatchNegotiatedReliable(const SipMessage& msg);
 
      void dispatchCancel(const SipMessage& msg);
      void dispatchBye(const SipMessage& msg);
      void dispatchUnknown(const SipMessage& msg);
 
      // utilities
      void startRetransmit1xxTimer();
      void startResubmit1xxRelTimer();
      void startRetransmit1xxRelTimer();
      void sendAccept(int code, Contents* offerAnswer); // sends 2xxI
      bool sendProvisional(int code, bool earlyFlag);  // returns true if sent reliably
      void queueResponse(int code, bool earlyFlag);
      void sendUpdate(const Contents& offerAnswer);
      bool handlePrack(const SipMessage& msg); // verify that prack matches our last send reliable 1xx
      void prackCheckQueue();                             // send a queued message after prack
      void updateCheckQueue();                            // send a queued message after update
 
      ServerInviteSession(DialogUsageManager& dum, Dialog& dialog, const SipMessage& msg);
 
      // stores the original request
      const SipMessage mFirstRequest;
      std::shared_ptr<SipMessage> m1xx; // for 1xx retransmissions
      unsigned long mCurrentRetransmit1xxSeq;
      
      // UAS Prack members
      unsigned int mLocalRSeq;
      std::shared_ptr<SipMessage> mUnacknowledgedReliableProvisional; // We won't send a new reliable provisional until the previous one is acknowledge - used for re-transmissions
      std::deque< std::pair<int, bool> > mQueuedResponses;
      bool mAnswerSentReliably;
      std::shared_ptr<SipMessage> mPrackWithOffer; // for 1xx retransmissions
};
 
}
 
#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/>.
 *
 */