ipcSave(2K)

NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO

NAME

ipcSave, ipcRestore- Save the current message; Restore a saved message as the current message

SYNOPSIS

#include <ipc/chIpc.h>

int ipcSave(int portli);
int ipcRestore(int msgid);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

FEATURES

IPC

DESCRIPTION

The ipcSave call saves the current thread's current message to a system buffer, and returns an identifier for the saved message. The portli argument reserved for future use. The caller should use the K_NONEPORT value for this parameter.

Messages used to be saved when a thread receives several messages and has to reply in a different order ( ipcReply (2K) is always applied to the current message; receiving a message supplants the current message). After ipcSave, there is no current message, and ipcReply (2K), ipcGetData (2K) or ipcSysInfo (2K) cannot be used unless a message is received (ipcReceive (2K)) or restored (ipcRestore (2K)).

The ipcRestore call restores a saved message as the current message. If the call is successful, the previous current message is replaced by the current message .

The number of messages that an actor may save is limited to K_CMSGSAVEDMAX.

RETURN VALUE

Upon successful completion, ipcRestore returns 0 and ipcSave returns a positive identifier for the saved message. Otherwise, a negative error code is returned. In case of failure, the current message is not erased.

ERRORS

[K_ENOMEM]

ipcSave : K_CMSGSAVEDMAX messages have already been saved by the calling actor.

[K_EINVAL]

ipcSave : no current message; ipcRestore : invalid identifier.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

ipcReceive(2K)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO