EventStackThread.hxx

Go to the documentation of this file.

#ifndef RESIP_EventStackThread__hxx
#define RESIP_EventStackThread__hxx

#include <vector>

#include "rutil/ThreadIf.hxx"
#include "rutil/FdPoll.hxx"
#include "rutil/SelectInterruptor.hxx"

namespace resip
{

class SipStackOptions;
class SipStack;
class SelectInterruptor;
class EventThreadInterruptor;
class FdPollGrp;

class EventStackThread : public ThreadIf
{
   public:
      EventStackThread(EventThreadInterruptor& si, FdPollGrp& pollGrp);
      EventStackThread(SipStack& stack, EventThreadInterruptor& si, FdPollGrp& pollGrp);
      virtual ~EventStackThread();

      /*
       * If you use the 1st constructor form, use this after creating
       * the stack to add it into the list to which the thread is providing
       * cycles. Even with only one active stack, this approach can
       * be used to solve the cyclic initialization problem.
       */
      void addStack(SipStack& stack);

      virtual void thread();
      virtual void shutdown();

   protected:
      /*
       * Return time (in milliseconds) until your next timer, or
       * ~30sec for infinity.
       */
      virtual unsigned int getTimeTillNextProcessMS() const;

      /*
       * Called after all socket IO and sip stack timers. Process
       * any application timers here.
       */
      virtual void afterProcess();

   private:
      typedef std::vector<SipStack*> StackList;
      StackList mStacks;
      EventThreadInterruptor& mIntr;
      FdPollGrp& mPollGrp;
};



class EventThreadInterruptor : public SelectInterruptor
{
   public:
      EventThreadInterruptor(FdPollGrp& pollGrp);
      virtual ~EventThreadInterruptor();
   protected:
      FdPollGrp& mPollGrp;      // used just to remove ourselves
      FdPollItemHandle mPollItemHandle;
};

class EventStackSimpleMgr
{
   public:
      EventStackSimpleMgr(const char *implName);
      ~EventStackSimpleMgr();
      /*
       * Configure {options} with our pollGrp and asyncHandler.
       * Use this prior to creating your SipStack instance.
       */
      void setOptions(SipStackOptions& options);

      /*
       * Convenience function to create SipStack instance. Will add
       * appropriate options, cerate the stack and add the stack to
       * the thread.
       */
      SipStack& createStack(SipStackOptions& options);


      /*
       * Thread accessor.
       * Use this to invoke addStack(), run(), shutdown(), join(), etc.
       */
      EventStackThread& getThread() { assert(mThread); return *mThread; }

      /*
       * Call to release all owned resources early. Stack must be
       * stopped and thread joined prior to releasing.
       */
      void release();

   protected:
      FdPollGrp* mPollGrp;
      EventThreadInterruptor* mIntr;
      EventStackThread* mThread;
      SipStack* mStack;
};

} // namespace

#endif


/* ====================================================================
 * 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 vocal@vovida.org.
 *
 * 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/>.
 *
 *  vi: set shiftwidth=3 expandtab:
 */