The Pedigree Project  0.1
native-ipc.h
1 /*
2  * Copyright (c) 2008-2014, Pedigree Developers
3  *
4  * Please see the CONTRIB file in the root of the source tree for a full
5  * list of contributors.
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #define _NATIVE_IPC_API_H
21 #define _NATIVE_IPC_API_H
22 
23 #include "pedigree/native/ipc/Ipc.h"
24 #include "pedigree/native/types.h"
25 
36 extern uintptr_t createStandardMessage(PedigreeIpc::IpcMessage *pMessage);
37 
46 extern uintptr_t createSharedMessage(
47  PedigreeIpc::IpcMessage *pMessage, size_t nBytes, uintptr_t handle);
48 
53 extern void *getIpcSharedRegion(PedigreeIpc::IpcMessage *pMessage);
54 
59 extern void destroyMessage(PedigreeIpc::IpcMessage *pMessage);
60 
64 extern bool sendIpc(
65  PedigreeIpc::IpcEndpoint *pEndpoint, PedigreeIpc::IpcMessage *pMessage,
66  bool bAsync);
67 
73 extern void *recvIpcPhase1(PedigreeIpc::IpcEndpoint *pEndpoint, bool bAsync);
74 
81 extern uintptr_t
82 recvIpcPhase2(PedigreeIpc::IpcMessage *pUserMessage, void *pMessage);
83 
87 extern void createEndpoint(const char *name);
88 
92 extern void removeEndpoint(const char *name);
93 
97 extern PedigreeIpc::IpcEndpoint *getEndpoint(const char *name);
A standard IPC message that is less than 4 KB in size.