MessageQueue.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
 
// forwards
namespace Arp { namespace System { namespace Ve
{
class IMessageQueueService;
}}}
 
namespace Arp { namespace System { namespace Commons { namespace Ipc
{
 
class MessageQueue
{
public: // enums
 
    enum class OpenMode
    {
        CreateNew = 0,              
        Open,                       
        OpenOrCreate,               
    };
 
    enum class Access
    {
        ReadOnly,                   
        WriteOnly,                  
        ReadWrite                   
    };
 
public: // construction/destruction
 
    MessageQueue(const String& name, bool blocking = false);
 
    MessageQueue(const String& name, OpenMode openMode, Access permission = Access::ReadWrite, bool blocking = false);
 
    MessageQueue(const String& name, OpenMode openMode, Access permission, bool blocking, long maxmsg, long msgsize);
 
    ~MessageQueue(void);
 
public: // setter/getter operations
 
    bool IsBlocking() const;
 
    long GetMessageCount() const;
 
    long GetMaxMessageCount() const;
 
    long GetMaxMessageSize() const;
 
public: // methods
 
    void Send(const char *pMsg, size_t len, unsigned int prio, Milliseconds timeoutMs = Milliseconds(0));
 
    size_t Receive(char *pBuffer, size_t len, unsigned int& prio, Milliseconds timeoutMs = Milliseconds(0));
 
    void Close();
 
    void Unlink();
 
private: // typedefs and usings
 
    using IMessageQueueService = Arp::System::Ve::IMessageQueueService;
 
private: // methods
 
    MessageQueue(const MessageQueue& arg) = delete;
 
    MessageQueue& operator=(const MessageQueue& arg) = delete;
 
private: // fields
 
    IMessageQueueService *pMessageQueueService;
 
private: // static fields
 
};
 
// inline methods of class MessageQueue
 
}}}} // end of namespace Arp::System::Commons::Ipc