TransactionUser.hxx

Go to the documentation of this file.

#if !defined(RESIP_TU_HXX)
#define RESIP_TU_HXX 

#include <iosfwd>
#include <set>
#include "rutil/TimeLimitFifo.hxx"
#include "rutil/Data.hxx"
#include "rutil/CongestionManager.hxx"
#include "resip/stack/Message.hxx"
#include "resip/stack/MessageFilterRule.hxx"


namespace resip
{
class SipMessage;

class TransactionUser
{
   public:
      void post(Message* msg);

      bool isMyDomain(const Data& domain) const;

      void addDomain(const Data& domain);

      virtual const Data& name() const=0;

      virtual EncodeStream& encode(EncodeStream& strm) const;

      void setMessageFilterRuleList(MessageFilterRuleList &rules);

      bool isRegisteredForTransactionTermination() const;

      bool isRegisteredForConnectionTermination() const;
      bool isRegisteredForKeepAlivePongs() const;

      inline CongestionManager::RejectionBehavior getRejectionBehavior() const
      {
         if(mCongestionManager)
         {
            return mCongestionManager->getRejectionBehavior(&mFifo);
         }
         return CongestionManager::NORMAL;
      }
      
      virtual void setCongestionManager(CongestionManager* manager)
      {
         if(mCongestionManager)
         {
            mCongestionManager->unregisterFifo(&mFifo);
         }
         mCongestionManager=manager;
         if(mCongestionManager)
         {
            mCongestionManager->registerFifo(&mFifo);
         }
      }
      
      virtual UInt16 getExpectedWait() const
      {
         return (UInt16)mFifo.expectedWaitTimeMilliSec();
      }
      
      // .bwc. This specifies whether the TU can cope with dropped responses
      // (due to congestion). Some TUs may need responses to clean up state,
      // while others may rely on TransactionTerminated messages. Those that
      // rely on TransactionTerminated messages will be able to return false
      // here, meaning that in dire congestion situations, the stack will drop
      // responses bound for the TU.
      virtual bool responsesMandatory() const {return true;}
      
   protected:
      enum TransactionTermination 
      {
         RegisterForTransactionTermination,
         DoNotRegisterForTransactionTermination
      };

      enum ConnectionTermination 
      {
         RegisterForConnectionTermination,
         DoNotRegisterForConnectionTermination
      };

      enum KeepAlivePongs 
      {
         RegisterForKeepAlivePongs,
         DoNotRegisterForKeepAlivePongs
      };

      TransactionUser(TransactionTermination t=DoNotRegisterForTransactionTermination,
                      ConnectionTermination c=DoNotRegisterForConnectionTermination,
                      KeepAlivePongs k=DoNotRegisterForKeepAlivePongs);

      TransactionUser(MessageFilterRuleList &rules, 
                      TransactionTermination t=DoNotRegisterForTransactionTermination,
                      ConnectionTermination c=DoNotRegisterForConnectionTermination,
                      KeepAlivePongs k=DoNotRegisterForKeepAlivePongs);

      virtual ~TransactionUser()=0;

      virtual bool isForMe(const SipMessage& msg) const;

      TimeLimitFifo<Message> mFifo;
      CongestionManager* mCongestionManager;

   private:      
      void postToTransactionUser(Message* msg, TimeLimitFifo<Message>::DepthUsage usage);
      unsigned int size() const;
      bool wouldAccept(TimeLimitFifo<Message>::DepthUsage usage) const;

   private:
      MessageFilterRuleList mRuleList;
      typedef std::set<Data> DomainList;
      DomainList mDomainList;
      bool mRegisteredForTransactionTermination;
      bool mRegisteredForConnectionTermination;
      bool mRegisteredForKeepAlivePongs;
      friend class TuSelector;      
};

EncodeStream& 
operator<<(EncodeStream& strm, const TransactionUser& tu);

}

#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/>.
 *
 */