uaclient.hxx

SIP（Session Initiation Protocol）是由IETF定义

#ifndef UaClient_hxx
#define UaClient_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 UaClient_hxx_Version =
    "$Id: UaClient.hxx,v 1.3.12.3 2003/03/04 00:42:52 sprajpat Exp $";

#include "UaBase.hxx" 

namespace Vocal {

namespace UA {

/** Object UaClient
<pre>
<br> Usage of this Class </br>

    This object is Client Side agent
class FooAgent : public BasicAgent
{
   public:

      FooAgent(Sptr<SipMsg> sMsg, AgentRole aRole);

}

FooAgent::FooAgent(Sptr<SipMsg> sipMsg, AgentRole aRole)

{
   Create the client
       if(aRole == CLIENT)

       {
        myInvokee = new UaClient(sipMsg, SomeHow.getSipTransceiver(), this);

       }
}

 For detailed Informantion about extensive use of this object please
 refer to /vocal/sip/gua/CallAgent.cxx
</pre>
*/
class UaClient : public UaBase
{
   public:
      ///
      UaClient( const Sptr<SipMsg>& reqMsg, Sptr<SipTransceiver> stack, BasicAgent* controllerAgent=0 )
          : UaBase(reqMsg, stack, controllerAgent)
      {
          myAgentRole = A_CLIENT;
      };
      ///
      string className() { return "UaClient"; };

      /**Constructs a BYE messages and sends it. Since it was the Client
       * for the initial INVITE, uses 200 response to construct a BYE message
       */   
      Sptr<SipMsg> sendBye();

};

}
}

#endif