ConnectionTerminated.hxx

Go to the documentation of this file.

#if !defined(RESIP_CONNECTIONTERMINATED_HXX)
#define RESIP_CONNECTIONTERMINATED_HXX 
 
#include "rutil/HeapInstanceCounter.hxx"
#include "resip/stack/TransactionMessage.hxx"
#include "resip/stack/TransportFailure.hxx"
#include "resip/stack/Tuple.hxx"
 
#include <list>
 
namespace resip
{
 
class ConnectionTerminated : public TransactionMessage
{
   public:
      RESIP_HeapCount(ConnectionTerminated);
 
      ConnectionTerminated(const Tuple& flow, 
         TransportFailure::FailureReason failureReason, 
         int failureSubCode, 
         const Data& failureString, 
         const std::list<Data>& additionalFailureStrings) :
         mFlow(flow), 
         mFailureReason(failureReason), 
         mFailureSubCode(failureSubCode), 
         mFailureString(failureString),
         mAdditionalFailureStrings(additionalFailureStrings)
      {
      }
      virtual const Data& getTransactionId() const { resip_assert(0); return Data::Empty; }
      virtual bool isClientTransaction() const { resip_assert(0); return false; }
      virtual Message* clone() const { return new ConnectionTerminated(mFlow, mFailureReason, mFailureSubCode, mFailureString, mAdditionalFailureStrings); }
      virtual EncodeStream& encode(EncodeStream& strm) const
      {
         encodeBrief(strm);
         strm << ", failureString=" << mFailureString;
         for (std::list<Data>::const_iterator it = mAdditionalFailureStrings.begin(); it != mAdditionalFailureStrings.end(); ++it)
         {
            strm << std::endl << "  " << *it;
         }
         return strm;
      }
      virtual EncodeStream& encodeBrief(EncodeStream& strm) const 
      {
         strm << "ConnectionTerminated: flow=" << mFlow
              << ", failureReason=" << TransportFailure::failureReasonToString(mFailureReason)
              << ", failureSubCode=" << mFailureSubCode;
         return strm;
      }
 
      FlowKey getFlowKey() const { return mFlow.mFlowKey; }
      const Tuple& getFlow() const { return mFlow; }
      TransportFailure::FailureReason getFailureReason() const { return mFailureReason; }
      int getFailureSubCode() const { return mFailureSubCode; }
      const Data& getFailureString() const { return mFailureString; }
      const std::list<Data>& getAdditionalFailureStrings() const { return mAdditionalFailureStrings; }
 
   private:
      const Tuple mFlow;
      TransportFailure::FailureReason mFailureReason;
      int mFailureSubCode;
      const Data mFailureString;
      const std::list<Data> mAdditionalFailureStrings;  // Note:  SSL certificate validation callback errors end up here
};
 
}
 
#endif
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * 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/>.
 *
 */