workerthread.hxx

Vovida 社区开源的 SIP 协议源码

#ifndef WORKER_THREAD_HXX
#define WORKER_THREAD_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 WorkerThread_hxx_Version = 
    "$Id: WorkerThread.hxx,v 1.21.24.1 2003/01/30 19:48:49 veer Exp $";


#include "Fifo.h"
#include "Sptr.hxx"
#include "ThreadIf.hxx"
#include "Builder.hxx"

namespace Vocal
{

class SipProxyEvent;


/** Onject WorkerThread
<pre>
<br> Usage of this Class </br>

    it is a ThreadIf. It has a input queue on which it is blocked.
    The input queue contains sip proxy events.

</pre>
*/
class WorkerThread: public ThreadIf
{
    public:


        /** Create the worker thread given the incoming sip event fifo and
         *  the builder. The incoming messages from the fifo will be 
         *  distributed to the builder.
         */
        WorkerThread( const Sptr < Fifo < Sptr < SipProxyEvent > > > inputFifo,
		      const Sptr < Builder > builder);


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


        /** Indicates to the thread that it needs to cease processing.
         */
        virtual void shutdown();


    protected:
    
    
        /** The method that does the work of distributing the sip events
         *  to the builder.
         */
        virtual void thread();


    private:


        /** Incoming sip events will come through this fifo. They will then
         *  be distributed to the builder.
         */
        Sptr < Fifo < Sptr < SipProxyEvent > > > myFifo;


        /** Responsible for handling sip events.
         */
        Sptr < Builder > myBuilder;


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

#endif // WORKER_THREAD_HXX