msg.h File Reference

#include <stddef.h>
#include <hipc.h>

Include dependency graph for msg.h:

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

Go to the source code of this file.

Macros
#define	hipcMsgBdyP(msg)   (&(msg)[HIPC_MSGHDR_SIZE])
	Returns a pointer to the body of a HIPC message. More...

Typedefs
typedef unsigned char	hipc_msg [HIPC_MSG_ALLOCSIZE]

Functions
size_t	hipcMsgTotalSize (const hipc_msg msg)
	Returns total size of a HIPC message, which is the header size plus the body size. More...
unsigned char	hipcMsgBdySize (const hipc_msg msg)
	Returns body size of a HIPC message. More...
const void *	hipcMsgBdyPtr (const hipc_msg msg)
	Returns a pointer to a body of a HIPC message. More...
unsigned char	hipcMsgType (const hipc_msg msg)
	Returns type of a HIPC message. More...
unsigned char	hipcMsgOffset (const hipc_msg msg)
	Returns offset of a HIPC message. More...
unsigned char	hipcMsgStruno (const hipc_msg msg)
	Returns structure number of a HIPC message. More...
unsigned char	hipcMsgRngsize (const hipc_msg msg)
	Returns range size of a HIPC message. More...

Macro Definition Documentation

#define hipcMsgBdyP

(

msg

)

(&(msg)[HIPC_MSGHDR_SIZE])

Returns a pointer to the body of a HIPC message.

Parameters

msg	HIPC message

Returns

pointer to the body of the HIPC message.

Definition at line 16 of file msg.h.

Typedef Documentation

typedef unsigned char hipc_msg[HIPC_MSG_ALLOCSIZE]

Definition at line 8 of file msg.h.

Function Documentation

size_t hipcMsgTotalSize

(

const hipc_msg

msg

)

Returns total size of a HIPC message, which is the header size plus the body size.

Parameters

msg	HIPC message

Returns

size of the HIPC message

Definition at line 9 of file msg.c.

References HIPC_MSGHDR_SIZE, and hipcMsghdrBdysize().

Referenced by hipcPosixWriteMsg(), mockWriteMsg(), and test_msg_sizes().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned char hipcMsgBdySize

(

const hipc_msg

msg

)

Returns body size of a HIPC message.

Parameters

msg	HIPC message

Returns

body size of the HIPC message

Definition at line 20 of file msg.c.

References hipcMsghdrBdysize().

Referenced by hipcPosixReadMsg(), mockReadMsg(), and test_msg_sizes().

Here is the call graph for this function:

Here is the caller graph for this function:

const void* hipcMsgBdyPtr

(

const hipc_msg

msg

)

Returns a pointer to a body of a HIPC message.

Parameters

msg	HIPC message

Returns

pointer to the body of the HIPC message

Definition at line 31 of file msg.c.

References HIPC_MSGHDR_SIZE.

Referenced by test_hipcMsgBdyPtr().

Here is the caller graph for this function:

unsigned char hipcMsgType

(

const hipc_msg

msg

)

Returns type of a HIPC message.

Parameters

msg	HIPC message

Returns

type of the HIPC message

Definition at line 42 of file msg.c.

References HIPC_MSGHDR_BYTE_TYPE.

Referenced by hipcOpen(), hipcWaitReturn(), and test_hipcMsgType().

Here is the caller graph for this function:

unsigned char hipcMsgOffset

(

const hipc_msg

msg

)

Returns offset of a HIPC message.

Parameters

msg	HIPC message

Returns

offset of the HIPC message

Definition at line 53 of file msg.c.

References HIPC_MSGHDR_BYTE_OFFSET.

Referenced by hipcWaitReturn(), and test_hipcMsgOffset().

Here is the caller graph for this function:

unsigned char hipcMsgStruno

(

const hipc_msg

msg

)

Returns structure number of a HIPC message.

Parameters

msg	HIPC message

Returns

structure number of the HIPC message

Definition at line 64 of file msg.c.

References HIPC_MSGHDR_BYTE_STRUNO.

Referenced by hipcWaitReturn(), and test_hipcMsgStruno().

Here is the caller graph for this function:

unsigned char hipcMsgRngsize

(

const hipc_msg

msg

)

Returns range size of a HIPC message.

Parameters

msg	HIPC message

Returns

range size of the HIPC message

Definition at line 75 of file msg.c.

References HIPC_MSGHDR_BYTE_BDYSZ.

Referenced by hipcWaitReturn(), and test_msg_sizes().

Here is the caller graph for this function: