www.beck-ipc.com

@CHIP-RTOS C Library - RTOS API


RTX_Wait_For_Msg

This function parks the calling task on the specified message exchange message queue.   The Message Exchange Manager will then wake up this task when either a message is available or a specified wait period timeout expires.

int RTX_Wait_For_Msg ( RTX_Wait_Msg far *msg_ptr );

Parameters

msg_ptr

Input parameter:   pointer to a RTX_Wait_Msg structure containing parameters.

Return Value

0 on success else error code, invalid ID or -28: no message available.

Comments

This procedure is identical to RTX_Wait_For_MsgP, except for method of parameter passing.

The format of the 12 byte message received is defined by the application program.

When more than one message is available at the message exchange, the oldest (FIFO order) message from the highest priority message queue will be reported.   Note that message priority and the wait priority,

    msg_ptr->prio ,

are independent and unrelated concepts.

See Also

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

Related Topics

RTX API   Overview

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3SC2x
    V1.00V1.00V1.00V0.90V1.00

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document