PxMbxRequest()

Request a mailbox handle.

APPLIES TO

1.0.0

SYNOPSIS

PxMbx_t PxMbxRequest (PxOpool_t opoolid);

ARGUMENTS

opoolid: The object pool, where the mailbox object is requested from

RETURN VALUES

Valid mailbox object handle on success
Invalid mailbox object handle on failure

ERROR CODES

PXERR_ACCESS_RIGHT

The calling task has not the right to access the object pool

PXERR_OPOOL_ILLOPOOL

opoolid is not a valid object pool

PXERR_OBJ_ABORTED

Request aborted by an event

PXERR_MBX_ILLMBX

Invalid mailbox in mailbox command

PXERR_EVENT_ZERO

The given event mask is zero

PXERR_GLOBAL_ILLEGAL_CORE

The requested object pool is not on the same core

PXERR_OBJ_NOOBJ

No free object is available

PXERR_OBJ_ILLOBJ

The passed object handle is not valid

PXERR_INTERNAL_INCONSISTENCY

Inconsistency of internal structures

DESCRIPTION

The PxMbxRequest function creates a mailbox object by converting a free object from object pool opool. The object handle is returned. If there is no free object available, the PxMbxRequest waits until a free object is available.

IMPLEMENTATION GUIDELINES

Before call

opoolid must be a valid PXROS-HR object pool and the calling task must have the access right to take objects from this object pool (V).
The validity of opoolid may also be checked by the PxOpoolIsValid macro (F). The object pool must be created on the same core as the caller runs on. The creator core id can be read with the macro PxOpoolCoreId and the own core id with PxGetCoreId (C). Typically the task’s default object pool PXOpoolTaskdefault is used for this purpose.

After call

The returned value is the id of type PxMbx_t. This id may be checked with one of the following macros:
- PxMbxIdIsValid() must be true.
- PxMbxIdGet() must not be _PXIllegalObjId.
- PxMbxIdError() must be PXERR_NOERROR otherwise the returned error code has to be interpreted (C).

Best Practice

PxMbxRequest may block, if no PXROS-HR object is available. If blocking calls are prohibited, PxMbxRequest_NoWait should be used instead.
PxMbxRequest should only be called during initialization to ensure the availability of the mailbox object.

SEE ALSO

USAGE

#include "pxdef.h"

PxMbx_t Mbx = PxMbxRequest(opoolid);

if (PxMbxIdError(Mbx) != PXERR_NOERROR) {
    // Report error
}