cinvalidstateexception.hxx

Vovida 社区开源的 SIP 协议源码

#ifndef CInvalidStateException_hxx
#define CInvalidStateException_hxx

/* ====================================================================
 * 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 [e-mail].
 *
 * 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/>.
 *
 */



static const char* const CInvalidStateException_hxx_Version = 
"$Id: CInvalidStateException.hxx,v 1.3.12.2 2003/01/30 00:28:42 veer Exp $";

#include "VException.hxx"

/** Object CInvalidStateException

<pre>
     <br> Usage of this Class </br>

     This class is used for throwing exceptions. In case new state is added
     into vocal/sip/libsipua/uaState then, the new class is UaStateFoo() then,
     functions in UaStateFoo() will throw the expection of type
     CInvalidStateException.

     In UaStateFoo.hxx

     Class UaStatefoo::public UaState
     {
      public:
      UaStatefoo();
      <br> void dosomething(UaBase& Agent, Sptr<SipMsg> msg)
      throw(CInvalidStateException&);</br>
      }

     In UaStateFoo.cxx

      void UaStateFoo::dosomething(UaBase& Agent, Sptr<SipMsg> msg)
      {
        char buf[256];
        sprintf(buf, "****Invalid state transition");
        cpLog(LOG_ALERT, buf);
        <br> throw CInvalidStateException(buf, __FILE__, __LINE__, 0); </br>
      }
</pre>

 */
class CInvalidStateException: public VException
{
public:
    
    CInvalidStateException( const string& msg,
			 const string& file,
			 const int line,
			 const int error = 0 )
    :VException(msg, file, line, error) { };
    
    ///
    string getName( void ) const { return "CInvalidStateException"; }
};


#endif