---

more/cf/threadfwd.h

Go to the documentation of this file.

//  Copyright (C) 2001  Petter Urkedal (petter.urkedal@matfys.lth.se)
//
//  This file is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This file is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//  As a special exception, you may use this file as part of a free
//  software library without restriction.  Specifically, if other files
//  instantiate templates or use macros or inline functions from this
//  file, or you compile this file and link it with other files to
//  produce an executable, this file does not by itself cause the
//  resulting executable to be covered by the GNU General Public
//  License.  This exception does not however invalidate any other
//  reasons why the executable file might be covered by the GNU General
//  Public License.
//
//  $Id: threadfwd.h,v 1.1 2002/05/30 18:01:37 petter_urkedal Exp $


#ifndef MORE_CF_THREADFWD_H
#define MORE_CF_THREADFWD_H

#include <more/bits/config.h>
#ifndef MORE_CF_DISABLE_THREADS
#  define MORE_CF_WITH_THREADS 1
#endif

namespace more {
namespace cf {

  ///\if bits
  namespace bits {
    // This variable is only modified when there only one thread.
    extern bool other_threads;
  }
  ///\endif

  /** True iff the caller is the only thread.  This provides a quick
      check whether mutex locking is needed. */
  inline bool there_are_only_threads() { return bits::other_threads; }

  /** Report that there is one more fereign thread running.  By
      foreign thread is meant one that is not created by libmore.
      This function must be called _before_ the thread is started.  If
      you run foreign threads and don't want to bother, just call
      notify_foreign_thread() once at startup.  If you don't need to
      access the libmore objects from these foreign threads, you don't
      need to call this function at all. */
  void notify_foreign_thread();

  /** Report that there is one less foreign (not created by libmore)
      thread running.  This must be called _after_ the thread is stopped. */
  void unnotify_foreign_thread();

}}
#endif

---