VxWorks Reference Manual : Libraries

distTBufLib

NAME

distTBufLib - distributed objects telegram buffer library (VxFusion)

ROUTINES

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

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.

INCLUDE FILES

distTBufLib.h

SEE ALSO

distTBufLib


Libraries : Routines

distTBufAlloc( )

NAME

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

SYNOPSIS


DIST_TBUF *distTBufAlloc()

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.

RETURNS

A telegram buffer (DIST_TBUF), or NULL if the allocation fails.

SEE ALSO

distTBufLib, distTBufFree


Libraries : Routines

distTBufFree( )

NAME

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

SYNOPSIS

void distTBufFree
    (
    DIST_TBUF * pTBuf /* ptr to telegram 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.

RETURNS

N/A

SEE ALSO

distTBufLib, distTBufAlloc