(Page 9 of 11 in this chapter) Version
TCAPRetrieveMessage
Description
- Retrieves the next message from the TCAP layer.
Prototype
- DWORD TCAPRetrieveMessage (CTAHD ctahd,
U8 *pMessage,
TcapRecvInfo *pInfoBlk)
- ctahd Context handle returned by ctaCreateContext.
- pMessage Address of the caller's message buffer, where the received message is returned to the caller. This buffer must be at least TCAP_MSG_SIZE bytes long (currently 512).
- pInfoBlk Address of the caller's receive information block, where information regarding the received message is returned to the caller.
Return Values
Details
- The user application must periodically call this routine to receive messages from the TCAP layer.
- If a message is received, it copies the message to the caller's message buffer, performing any necessary byte order translation to convert to the host's native byte ordering. Information relative to the received message is returned to the caller in the infoBlk parameter. The event structure associated with a received message and the information returned in the receive information block depend on the type of message received from the TCAP layer (as determined by the value of the infoBlk.indType field).
- For all events other than TCAP_EVENT_DAT_IND events, all relevant event information is copied from the message buffer directly to the caller's receive information block and the message buffer can be deallocated or reused immediately upon return from this function.
- For TCAP_EVENT_DAT_IND events, however, the component portion, application component, parameters, and any user dialog information present in the message remain in the caller's message buffer upon return from this function. Therefore, the caller must preserve the contents of the message buffer until all component data, component parameters, and dialog portion user information have been retrieved (through TCAPGetComp) and processed completely or copied to a safe location.
- The infoBlk defines the type of event received and other event-specific attributes of the incoming message. The structure of the receive information block is defined in Appendix A.
(Page 9 of 11 in this chapter) Version
Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2002, NMS Communications Corporation. All rights
reserved.