ConditionVariable.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef KERNEL_PROCESS_CONDITIONVARIABLE_H
#define KERNEL_PROCESS_CONDITIONVARIABLE_H

#include "pedigree/kernel/Spinlock.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/time/Time.h"
#include "pedigree/kernel/utilities/List.h"
#include "pedigree/kernel/utilities/Result.h"
#include "pedigree/kernel/utilities/new"

class Mutex;
class Thread;

class EXPORTED_PUBLIC ConditionVariable
{
  public:
    enum Error
    {
        NoError,
        TimedOut,
        ThreadTerminating,
        MutexNotLocked,
        MutexNotAcquired
    };

    typedef Result<bool, Error> WaitResult;

    ConditionVariable();
    ~ConditionVariable();

    WaitResult wait(Mutex &mutex, Time::Timestamp &timeout);

    WaitResult wait(Mutex &mutex);

    void signal();

    void broadcast();

  private:
    Spinlock m_Lock;

    List<Thread *> m_Waiters;

#ifndef THREADS
    void *m_Private;
#endif
};

#endif