VxWorks API Reference : OS Libraries

distTBufLib

NAME

distTBufLib - distributed objects telegram buffer library (VxFusion option)

ROUTINES

distTBufAlloc( ) - allocate a telegram buffer from the pool of buffers (VxFusion option)
distTBufFree( ) - return a telegram buffer to the pool of buffers (VxFusion option)

DESCRIPTION

This library provides routines for allocating and freeing telegram buffers. Telegrams are the largest packets that can be sent between nodes by the distributed objects product; their size is limited by the MTU size of the underlying communications. If a distributed objects message exceeds the space allocated in a telegram for message data, that message is divided into multiple telegrams that are sent out in sequence.

AVAILABILITY

This module is distributed as a component of the unbundled distributed message queues option, VxFusion.

INCLUDE FILES

distTBufLib.h


OS Libraries : Routines

distTBufAlloc( )

NAME

distTBufAlloc( ) - allocate a telegram buffer from the pool of buffers (VxFusion option)

SYNOPSIS

DIST_TBUF * distTBufAlloc (void)

DESCRIPTION

This routine allocates a telegram buffer from a pre-allocated pool of telegram buffers.

It is the responsibility of the caller to use the distTBufFree( ) routine to free the buffer when the caller is finished with it.

AVAILABILITY

This routine is distributed as a component of the unbundled distributed message queues option, VxFusion.

RETURNS

A pointer to a DIST_TBUF, or NULL if the allocation fails.

SEE ALSO

distTBufLib, distTBufFree


OS Libraries : Routines

distTBufFree( )

NAME

distTBufFree( ) - return a telegram buffer to the pool of buffers (VxFusion option)

SYNOPSIS

void distTBufFree
    (
    DIST_TBUF * pTBuf         /* ptr to buffer to be returned to pool */
    )

DESCRIPTION

This routine returns a buffer previously allocated to a caller back to the pool of free telegram buffers.

AVAILABILITY

This routine is distributed as a component of the unbundled distributed message queues option, VxFusion.

RETURNS

N/A

SEE ALSO

distTBufLib, distTBufAlloc