event.h

/* event.h */
/*
 * Copyright information and license terms for this software can be
 * found in the file LICENSE that is included with the distribution
 */
/**
 *  @author mrk
 */
#ifndef EVENT_H
#define EVENT_H

#include <memory>
#include <vector>

#include <epicsEvent.h>
#include <shareLib.h>

#include <pv/pvType.h>
#include <pv/sharedPtr.h>


namespace epics { namespace pvData {

class Event;
typedef std::tr1::shared_ptr<Event> EventPtr;

/**
 * @brief C++ wrapper for epicsEvent from EPICS base.
 *
 */
class epicsShareClass Event {
public:
    POINTER_DEFINITIONS(Event);
    /**
     * Constructor
     */
    explicit Event(bool = false);
    /**
     * Destructor.
     */
    ~Event();
    /**
     * Signal the event i.e. ensures that the next or current call to wait completes. 
     */
    void signal();
    /**
     * wait 
     * @return (false,true) if (some error, event signaled).
     * The next wait or tryWait will clear signal.
     */
    bool wait (); /* blocks until full */
    /**
     * wait for up to timeOut seconds.
     * @param timeOut max number of seconds to wait
     * @return (false, true) if (timeout or error, event signaled).
     */
    bool wait ( double timeOut ); /* false if empty at time out */
    /**
     * See if a signal has been called.
     * @return (false, true) if (timeout or error, event signaled).
     */
    bool tryWait (); /* false if empty */
private:
    epicsEventId id;
};

}}
#endif  /* EVENT_H */