TimeoutGuard.h

Go to the documentation of this file.

/*
 * 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 TIMEOUT_GUARD_H
#define TIMEOUT_GUARD_H

#include "pedigree/kernel/Spinlock.h"
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/process/Event.h"
#include "pedigree/kernel/process/eventNumbers.h"
#include "pedigree/kernel/processor/state.h"
#include "pedigree/kernel/processor/types.h"

class EXPORTED_PUBLIC TimeoutGuard
{
  public:
    TimeoutGuard(size_t timeoutSecs);

    ~TimeoutGuard();

    bool timedOut()
    {
        return m_bTimedOut;
    }

    void cancel() NORETURN;

    class TimeoutGuardEvent : public Event
    {
      public:
        TimeoutGuardEvent() : Event(0, false), m_pTarget(0)
        {
        }
        TimeoutGuardEvent(TimeoutGuard *pTarget, size_t specificNestingLevel);
        virtual ~TimeoutGuardEvent();

        virtual size_t serialize(uint8_t *pBuffer);
        static bool unserialize(uint8_t *pBuffer, TimeoutGuardEvent &event);

        virtual size_t getNumber()
        {
            return EventNumbers::TimeoutGuard;
        }

        TimeoutGuard *m_pTarget;

      private:
        TimeoutGuardEvent(const TimeoutGuardEvent &);
        TimeoutGuardEvent &operator=(const TimeoutGuardEvent &);
    };

  private:
    TimeoutGuard(const TimeoutGuard &);
    TimeoutGuard &operator=(const TimeoutGuard &);

    TimeoutGuardEvent *m_pEvent;

    bool m_bTimedOut;

#ifdef THREADS
    SchedulerState m_State;
#else
    void *m_State;
#endif

    size_t m_nLevel;

    Spinlock m_Lock;
};

#endif