timerevent.hxx

SIP（Session Initiation Protocol）是由IETF定义

#ifndef TIMER_EVENT_HXX
#define TIMER_EVENT_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 TimerEvent_hxx_Version = 
    "$Id: TimerEvent.hxx,v 1.28.2.1 2003/01/30 19:48:49 veer Exp $";


#include "SipProxyEvent.hxx"
#include "SipTransceiver.hxx"

namespace Vocal
{


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

    TimerEvent is a SipProxyEvent. This event is posted when a timer goes off.

</pre>
*/
class TimerEvent : public SipProxyEvent
{
    public:


        /** Create a timer event given the associate fifo.
         */
        TimerEvent(Sptr < Fifo < Sptr < SipProxyEvent > > > outputFifo);


        /** Virtual destructor
         */
        virtual ~TimerEvent();


        /** Post the given event to the associated fifo to expire in
         *  timerMs milliseconds.
         */
        void startTimer(Sptr < SipProxyEvent > newEvent, const int timerMs);


        /** Cancel this previously started timer.
         */
        void cancelTimer();


        /** Remove the call associated with the call info from the
         *  call container.
         */
        void removeCall();


        /** Return the timer id of this previously started timer.
         */
        FifoEventId getTimerId();


        /** Name of this class.
         */
        virtual const char* const name() const
        {
            return ( "TimerEvent" );
        }


        /** Associate a sip stack with this event.
         */
        void setSipStack(const Sptr < SipTransceiver > sipStack);


        /** Accessor to the associated sip stack. 
         *  May be 0 if a sip stack hasn't been associate with this event.
         */
        Sptr < SipTransceiver > getSipStack() const;


    private:


        /** Sip transceiver associate with this event.
         */
        Sptr < SipTransceiver > mySipStack;
        

        /** Suppress copying
         */
        TimerEvent(const TimerEvent &);
        

        /** Suppress copying
         */
        const TimerEvent & operator=(const TimerEvent &);
};
 
}


#endif // TIMER_EVENT_HXX