mtsMailBox.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Peter Kazanzides
  Created on: 2007-09-05

  (C) Copyright 2007-2014 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/


#ifndef _mtsMailBox_h
#define _mtsMailBox_h

#include <cisstMultiTask/mtsQueue.h>

// Always include last
#include <cisstMultiTask/mtsExport.h>

class mtsExecutionResult;

class CISST_EXPORT mtsMailBox
{
    mtsQueue<mtsCommandBase *> CommandQueue;

    std::string Name;

    mtsCallableVoidBase * PostCommandQueuedCallable;

    mtsCommandVoid * PostCommandDequeuedCommand;

    mtsCommandVoid * PostCommandReturnDequeuedCommand;

    void TriggerPostQueuedCommandIfNeeded(bool isBlocking, bool isBlockingReturn);

    void TriggerFinishedEventIfNeeded(const std::string &commandName, mtsCommandWriteBase *finishedEvent,
                                      mtsGenericObject *resultPointer, const mtsExecutionResult &result) const;

public:
    mtsMailBox(const std::string & name,
               size_t size,
               mtsCallableVoidBase * postCommandQueuedCallable = 0);

    ~mtsMailBox(void);

    const std::string & GetName(void) const;

    bool Write(mtsCommandBase * command);

    bool ExecuteNext(void);

    void SetSize(size_t size);

    bool IsEmpty(void) const;

    bool IsFull(void) const;

    void SetPostCommandDequeuedCommand(mtsCommandVoid * command);
    mtsCommandVoid *GetPostCommandDequeuedCommand(void) const;

    void SetPostCommandReturnDequeuedCommand(mtsCommandVoid * command);
    mtsCommandVoid *GetPostCommandReturnDequeuedCommand(void) const;

};


#endif // _mtsMailbox_h