ResponseContext.hxx

Go to the documentation of this file.

#if !defined(RESIP_RESPONSE_CONTEXT_HXX)
#define RESIP_RESPONSE_CONTEXT_HXX 
 
#include <iosfwd>
#include <map>
#include <list>
 
#include "rutil/HashMap.hxx"
#include "resip/stack/NameAddr.hxx"
#include "resip/stack/SipMessage.hxx"
#include "resip/stack/Via.hxx"
#include "resip/stack/Uri.hxx"
#include "resip/stack/MessageDecorator.hxx"
 
#include "repro/Target.hxx"
#include "rutil/resipfaststreams.hxx"
 
namespace resip
{
class SipMessage;
class Transport;
}
 
namespace repro
{
 
class RequestContext;
 
class ResponseContext
{
   public:
      class CompareStatus
      {
         public:
            bool operator()(const resip::SipMessage& lhs, const resip::SipMessage& rhs) const;
      };      
      
      virtual ~ResponseContext();
 
      resip::Data addTarget(const resip::NameAddr& target, bool beginImmediately=false);
 
      bool addTarget(std::unique_ptr<repro::Target> target, bool beginImmediately = false, bool checkDuplicates = true);
 
      bool addTargetBatch(TargetPtrList& targets, bool highPriority=false);
            
      bool beginClientTransactions();
      
      bool beginClientTransaction(const resip::Data& serial);
      
      bool cancelActiveClientTransactions(const resip::Tokens* reasons = 0);
      
      bool cancelAllClientTransactions(const resip::Tokens* reasons = 0);
      
      bool clearCandidateTransactions(const resip::Tokens* reasons = 0);
      
      bool cancelClientTransaction(const resip::Data& serial, const resip::Tokens* reasons = 0);
            
      Target* getTarget(const resip::Data& serial) const;
 
      //Keyed by transaction id
      typedef std::map<resip::Data,repro::Target*> TransactionMap;
 
      const TransactionMap& getCandidateTransactionMap() const;
      
      bool hasCandidateTransactions() const;
      
      bool hasActiveTransactions() const;
      
      bool hasTerminatedTransactions() const;
 
      bool hasTargets() const;
      
      bool isCandidate(const resip::Data& tid) const;
      
      bool isActive(const resip::Data& tid) const;
      
      bool isTerminated(const resip::Data& tid) const;
      
      bool areAllTransactionsTerminated() const;
 
      
      int getPriority(const resip::SipMessage& msg);
 
      //tightly coupled.
      RequestContext& mRequestContext;
      
      std::list<std::list<resip::Data> > mTransactionQueueCollection;
      resip::Data mCurrentResponseTid;
 
   protected:
      // only constructed by RequestContext
      ResponseContext(RequestContext& parent);
 
      // These methods are really private. These are not intended to be used
      // by anything other than RequestContext or ResponseContext.
 
      // call this from RequestContext when a CANCEL comes in 
      void processCancel(const resip::SipMessage& request);
 
      // call this from RequestContext after the lemur chain for any response 
      void processResponse(resip::SipMessage& response);
 
      void updateTimerC(const resip::Data &tid);
      void processTimerC(const resip::Data &tid, int serial);
 
      void beginClientTransaction(repro::Target* target);
      void cancelClientTransaction(repro::Target* target, const resip::Tokens* reasons = 0);
 
      void terminateClientTransaction(const resip::Data& tid);
      void removeClientTransaction(const resip::Data& transactionId); 
      
      //There is no terminateClientTransaction(Target target) since terminating
      //a branch is very simple. The guts can be found in the API functions.
      
      void insertRecordRoute(resip::SipMessage& outgoing,
                             const resip::Tuple& receivedTransportTuple,
                             const resip::NameAddr& receivedTransportRecordRoute, 
                             bool transportSpecificRecordRoute,
                             Target* target,
                             bool doPathInstead=false);
      resip::Data getInboundFlowToken(bool doPathInstead);
      bool outboundFlowTokenNeeded(Target* target);
      bool needsFlowTokenToWork(const resip::NameAddr& contact) const;
      bool sendingToSelf(Target* target);
 
      std::unique_ptr<resip::SipMessage> buildTargetRequest(Target *target);
      void sendRequest(resip::SipMessage& request);
      
      TransactionMap mCandidateTransactionMap; //Targets with status Candidate.
      TransactionMap mActiveTransactionMap; //Targets with status Trying, Proceeding, or WaitingToCancel.
      TransactionMap mTerminatedTransactionMap; //Targets with status Terminated.
 
      //Maybe someday canonicalized Uris will go here, and checking for duplicates
      //will be much faster
      resip::ContactList mTargetList;
      
      bool isDuplicate(const repro::Target* target) const;
      
      resip::SipMessage mBestResponse;
      int mBestPriority;
      bool mSecure;
      bool mIsClientBehindNAT;  // Only set if InteropHelper::getClientNATDetectionEnabled() is true
      
      static const int TimerCSerialInit = 0;
      std::unordered_map<resip::Data, int> mTimerCSerial; // Keeping track of the latest TimerC for each of the client TXs
 
      virtual void forwardBestResponse();
 
      friend class RequestContext;
      friend EncodeStream& operator<<(EncodeStream& strm, const repro::ResponseContext& rc);
};
 
EncodeStream&
operator<<(EncodeStream& strm, const repro::ResponseContext& rc);
 
}
#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/>.
 *
 */