RM transport callout functions used by RM to allocate and send RM packets via the application data paths between RM instances.
More...
#include <rm_transport.h>
Detailed Description
RM transport callout functions used by RM to allocate and send RM packets via the application data paths between RM instances.
Field Documentation
Description
This function pointer describes the RM transport layer packet allocation function. The application must supply an alloc function to RM instances at transport registration if the RM instance is intended to communicate with other RM instances. The function provided by the application must match this prototype. The provided function implements the allocation of packet buffers from the application data path that the RM transport will use to send messages between RM instances. The Rm_Packet pointer will point to start of the data buffer containing the RM packet data. The pktHandle will point to the start of the application data path "packet" data structure. The Rm_Packet pointer and pktHandle cannot be NULL. They will either be different or the same value based on the application transport.
- Parameters:
-
[in] | appTransport | Application transport handle to allocate packet from. This value is provided by the application at transport registration. |
[in] | pktSize | Size of buffer needed by RM for the RM packet. The application must place this value in the pktLenBytes field of the Rm_Packet. after the buffer has been allocated. |
[out] | pktHandle | Pointer to the start of the application's transport "packet". Could be the pointer to the start of a QMSS descriptor, network packet, etc. |
- Return values:
-
Success | - Pointer to allocated packet buffer. |
Failure | - NULL |
Description
This function pointer describes the RM transport layer packet send function. The application must supply a send function to RM instances at transport registration if the RM instance is intended to communicate with other RM instances. The function provided by the application must match this prototype. The provided function implements the sending of application data path packets, encapsulating RM packets, between RM instances. The pktHandle will point to the start of the application data path "packet" data structure.
RM assumes that the application will free application data path packet and the buffer containing the Rm_Packet after the send operation.
- Parameters:
-
[in] | appTransport | Application transport handle to send packet on. This value is provided by the application at transport registration. |
[in] | pktHandle | Pointer to the start of the application's transport "packet". Could be the pointer to the start of a QMSS descriptor, network packet, etc. |
- Return values:
-
0 | - Packet sent okay. |
< | 0 - Packet send failed. |
The documentation for this struct was generated from the following file: