modules/subsys/native/include/pedigree/native/ipc/Ipc.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _NATIVE_IPC_H
#define _NATIVE_IPC_H

#include "pedigree/native/compiler.h"
#include "pedigree/native/types.h"

namespace PedigreeIpc
{
class EXPORTED_PUBLIC StandardIpcMessage
{
  public:
    StandardIpcMessage();
    virtual ~StandardIpcMessage();

    virtual bool initialise();

    StandardIpcMessage(void *);

    virtual void *getBuffer() const
    {
        return static_cast<void *>(m_vAddr);
    }

  protected:
    void *m_vAddr;
};

class EXPORTED_PUBLIC SharedIpcMessage : public StandardIpcMessage
{
  public:
    SharedIpcMessage(size_t nBytes, void *existingHandle);
    virtual ~SharedIpcMessage();

    virtual bool initialise();

    void *getHandle() const
    {
        return m_pHandle;
    }

    size_t getSize() const
    {
        return m_nBytes;
    }

  private:
    size_t m_nBytes;
    void *m_pHandle;
};

typedef void *IpcEndpoint;

EXPORTED_PUBLIC bool
send(IpcEndpoint *pEndpoint, StandardIpcMessage *pMessage, bool bAsync = false);
EXPORTED_PUBLIC bool recv(
    IpcEndpoint *pEndpoint, StandardIpcMessage **pMessage, bool bAsync = false);

EXPORTED_PUBLIC IpcEndpoint *getEndpoint(const char *name);

EXPORTED_PUBLIC void createEndpoint(const char *name);
EXPORTED_PUBLIC void removeEndpoint(const char *name);

typedef StandardIpcMessage IpcMessage;
};  // namespace PedigreeIpc

#endif