OSMMsgFreeReqBuf(D3i2o)

OSMMsgFreeReqBuf -- free message frame

Synopsis

#include <i2o/common.h>

int OSMMsgFreeReqBuf(int iop, void *buffer)

Description

Message frames are normally freed automatically by OSMMsgSend. If the OSM finds itself with a message frame that it no longer wants, or the i2oOSMSend fails, then the OSM may call OSMMsgFreeReqBuf to free the message frame. The transport layer will convert the message to an i2oUtilNop if required.

Arguments

iop: Global IOP number from which the message frame was obtained.
buffer: Pointer to the message.

Return values

SUCCESS: The function succeeded.
EINVAL: iop is invalid.

Usage

Context

All contexts

Synchronization constraints

Does not block.

Driver-defined basic locks, read/write locks, and sleep locks may be held across calls to this function.

Hardware applicability

All

Version applicability

i2omsg: in HDK Technical Reference 2

Differences between versions

None

References

Intro(D3i2o), OSMMsgFreeRepBuf(D3i2o)