AndroMeta/include/AndroMeta/MMessageHandler.h

Go to the documentation of this file.

/*
 * Copyright 2009-2012 AndroMeta LLC. All rights reserved.
 *
 * AndroMeta LLC retains all intellectual property and proprietary 
 * rights to this software and related documentation and any modifications 
 * thereto.  Any use, reproduction, disclosure, or distribution of this 
 * software and related documentation without an express license agreement 
 * from AndroMeta LLC is strictly prohibited.
 * 
 */

#ifndef ANDROMETA_M_MESSAGE_HANDLER_H
#define ANDROMETA_M_MESSAGE_HANDLER_H

#include <AndroMeta/MTime.h>

namespace Meta{
  
  class MMessageBuffer;
  class MMessage;
  
  class MMessageHandler{
  public:
    
    enum Action{
      ReleaseContinue,
      SaveContinue,
      SaveStop,
      ReleaseStop
    };
    
    MMessageHandler();
    
    virtual ~MMessageHandler();
    
    void addBuffer(MMessageBuffer* buf);
    
    void removeBuffer(MMessageBuffer* buf, bool all=true);
    
    void clearBuffers();
    
    void setStartIndex(const mvar& index);
    
    void setEndIndex(const mvar& index);
    
    const mvar& startIndex() const;
    
    const mvar& endIndex() const;
    
    bool await(MMessageBuffer* buf);
    
    bool await(MMessageBuffer* buf, const mtime& timeout); 
    
    void interrupt();
    
    void setAllowInterrupt(bool flag);
    
    bool allowInterrupt();
    
    void handleMessages();
    
    virtual Action handleMessage(const MMessage* msg) = 0;
    
    friend class MMessageHandler_;
    
  private:
    MMessageHandler& operator=(const MMessageHandler&);
    MMessageHandler(const MMessageHandler&);
    
    class MMessageHandler_* x_;
  };
  
} // end namespace Meta

#endif // ANDROMETA_M_MESSAGE_HANDLER_H