IPC Module - ipc_core_spec

IPC Core Module

Messages

message ipc_send_error_ind

Parameters:

msg_type (int32) – Type ID of the sent message
reason (enum ipc_send_error_reason) – Reason why the message could not be delivered

message ipc_open_session_req

Request to open a communication session with a peer

message ipc_open_session_rsp

Parameters:: result (enum ipc_open_session_result) – The result of trying to open the session

Open communication session response

message ipc_close_session_req_norsp: Close communication session with the pee

message ipc_session_opened_ind

Received when the peer opened a session Only expected to be received by services.

Triggered when the peer opened a session using a_ipc_msg_ipc_open_session_req

message ipc_session_closed_ind

Parameters:: reason (enum ipc_session_closed_reason) – Reason why the session was closed

Received when the peer closed the session either due to an explicit request or a timeout (e.g. other peer exited).

message ipc_debug_command_req_norsp

Parameters:: command (enum ipc_debug_command) – Command to send to other side

Internal IPC debugging functions

enum ipc_send_error_reason

Constant	Value	Description
SEND_FAILED	0	Generic send failure
PEER_UNREACHABLE	1	The peer was not reachable
TRANSPORT_ERROR	2	Error in the underlying transport protocol
NO_SESSION	3	No active sesion, but one is needed. See #a_ipc_msg_ipc_open_session_req
SESSION_EXISTS	4	A session is already open towards the peer

enum ipc_open_session_result

Result when trying to open a session

Constant	Value	Description
OK	0	Session opened successfully
ERROR	1	Session did not open. Unknown error.
ERROR_NO_SLOTS_AVAILABLE	2	Session did not open. Peer has no session slots available.

enum ipc_session_closed_reason

Reason why a session was closed

Constant	Value	Description
REQUESTED	0	The other peer requested it to be closed
TIMEOU	1	Timeout when communicating

enum ipc_subscribe_result

Result of subscribing

Constant	Value	Description
OK	0	Successfully subscribed
ERROR	1	Failed to subscribe

enum ipc_debug_command

Command sent to IPC implementation for remote debugging functions

Constant	Value	Description
DEBUG_DUMP_USAGE	0	Dump IPC usage statistics
DEBUG_RESERVED	255	Empty command