ipc.h File Reference

#include <mos/types.h>

Include dependency graph for ipc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ipc_msg_t
	An IPC message. More...

Typedefs
typedef fd_t	ipcfd_t

Functions
MOSAPI ipc_msg_t *	ipc_msg_create (size_t size)
	Create a new IPC message.
MOSAPI void	ipc_msg_destroy (ipc_msg_t *buffer)
	Destroy an IPC message.
MOSAPI ipc_msg_t *	ipc_read_msg (ipcfd_t fd)
	Read an IPC message.
MOSAPI bool	ipc_write_msg (ipcfd_t fd, ipc_msg_t *buffer)
	Write an IPC message.
MOSAPI size_t	ipc_read_as_msg (ipcfd_t fd, char *buffer, size_t buffer_size)
MOSAPI bool	ipc_write_as_msg (ipcfd_t fd, const char *data, size_t size)

Typedef Documentation

ipcfd_t

typedef fd_t ipcfd_t

Definition at line 11 of file ipc.h.

Function Documentation

ipc_msg_create()

MOSAPI ipc_msg_t * ipc_msg_create

(

size_t

size

)

Create a new IPC message.

Parameters

size	The size of the message.

Returns

ipc_msg_t* The message.

Definition at line 27 of file libipc.cpp.

Referenced by ipc_read_msg().

ipc_msg_destroy()

MOSAPI void ipc_msg_destroy

(

ipc_msg_t *

buffer

)

Destroy an IPC message.

Parameters

buffer

The message.

Definition at line 34 of file libipc.cpp.

Referenced by ipc_read_msg(), rpc_call_exec(), and rpc_handle_client().

ipc_read_msg()

MOSAPI ipc_msg_t * ipc_read_msg

(

ipcfd_t

fd

)

Read an IPC message.

Parameters

fd	The file descriptor.

Returns

ipc_msg_t* The message.

Definition at line 39 of file libipc.cpp.

Referenced by rpc_call_exec(), and rpc_handle_client().

Here is the call graph for this function:

ipc_write_msg()

MOSAPI bool ipc_write_msg	(	ipcfd_t	fd,
		ipc_msg_t *	buffer )

Write an IPC message.

Parameters

fd	The file descriptor.
buffer	The message.

Returns

true The message was written.

false The message was not written.

Definition at line 68 of file libipc.cpp.

ipc_read_as_msg()

MOSAPI size_t ipc_read_as_msg	(	ipcfd_t	fd,
		char *	buffer,
		size_t	buffer_size )

Definition at line 106 of file libipc.cpp.

ipc_write_as_msg()

MOSAPI bool ipc_write_as_msg	(	ipcfd_t	fd,
		const char *	data,
		size_t	size )

Definition at line 87 of file libipc.cpp.

Referenced by rpc_call_exec(), and rpc_handle_client().