sipuseragent.hxx

Vovida 社区开源的 SIP 协议源码

#ifndef SipUserAgent_HXX
#define SipUserAgent_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/>.
 *
 */

#include "global.h"
static const char* const SipUserAgentVersion =
    "$Id: SipUserAgent.hxx,v 1.23.2.1 2003/02/20 00:52:53 bko Exp $";



#include "Data.hxx"
#include "SipHeader.hxx"

namespace Vocal
{
    
///
enum SipUserAgentErrorType
{
    DECODE_USERAGENT_FAILED,
    SCAN_USERAGENT_FAILED

    //may need to change this to be more specific
};

/// Exception handling class
class SipUserAgentParserException : public VException
{
    public:
        ///
        SipUserAgentParserException( const string& msg,
                                     const string& file,
                                     const int line,
                                     const int error = 0 );
        ///
        SipUserAgentParserException( const string& msg,
                                     const string& file,
                                     const int line,
                                     SipUserAgentErrorType i)
        : VException( msg, file, line, static_cast < int > (i))
        {
            value = i;
        }
        ///
        SipUserAgentErrorType getError() const
        {
            return value;
        }
        ///
        string getName() const ;
    private:
        SipUserAgentErrorType value;

};


/// data container for UserAgent header
class SipUserAgent: public SipHeader
{
    public:
        /// Create one with default values
        SipUserAgent();

        // TODO - add more constructors that take the parameters needed to build it

        // TODO - add accessor functions to get at the sub components

        /*** Create by decoding the data string passed in. This is the decode
        or parse. This call should only be used inside the stack and is
        not part of the API */
        SipUserAgent( const Data& srcData );
        ///
        SipUserAgent( const SipUserAgent& src );

        ///
        const SipUserAgent& operator=(const SipUserAgent& rhs);

	/// comparison operator
	bool operator==(const SipUserAgent& src) const;

        ///
        const Data& getProduct() const;
        ///
        const Data& getComment() const;
        ///
        const Data& getVersion() const;
        ///
        void setProduct( const Data& newData);
        ///
        void setComment( const Data& newcomment);
        ///
        void setVersion (const Data& newversion);
        ///
        void scanSipUserAgent(const Data &tmpdata);
        /*** return the encoded string version of this. This call should only be
        used inside the stack and is not part of the API */
        ///
        Data encode() const;
	/// method for copying sip headers of any type without knowing which type
	SipHeader* duplicate() const;
	/// compare two headers of (possibly) the same class
	virtual bool compareSipHeader(SipHeader* msg) const;
	

    private:
        Data data;
        Data product;
        Data version;
        Data comment;
        bool flgcomment;
        bool flgproduct;
        void decode(const Data& data);

        friend class SipMsg; 
};
 
} // namespace Vocal

/* Local Variables: */
/* c-file-style: "stroustrup" */
/* indent-tabs-mode: nil */
/* c-file-offsets: ((access-label . -) (inclass . ++)) */
/* c-basic-offset: 4 */
/* End: */
#endif