Channel.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBIPC_CHANNEL_H
#define __LIBIPC_CHANNEL_H
 
#include <Types.h>
 
class Channel
{
  public:
 
    enum Result
    {
        Success,
        InvalidArgument,
        InvalidMode,
        InvalidSize,
        IOError,
        ChannelFull,
        NotFound,
        NotSupported
    };
 
    enum Mode
    {
        Producer,
        Consumer
    };
 
  public:
 
    Channel(const Mode mode, const Size messageSize);
 
    virtual ~Channel();
 
    const Size getMessageSize() const;
 
    virtual Result read(void *buffer);
 
    virtual Result write(const void *buffer);
 
    virtual Result flush();
 
  protected:
 
    const Mode m_mode;
 
    const Size m_messageSize;
};
 
#endif /* __LIBIPC_CHANNEL_H */