WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 Operating Systems: Linux, Windows

Requestor

An application uses a requestor to send a request message and then wait for, and receive, the reply.

Functions

Summary of functions:
Function Description
xmsRequestorClose Close the requestor.
xmsRequestorCreate Create a requestor.
xmsRequestorRequest Send a request message and then wait for, and receive, a reply from the application that receives the request message.

xmsRequestorClose – Close Requestor

Interface:
xmsRC xmsRequestorClose(xmsHRequestor *requestor,
                        xmsHErrorBlock errorBlock);

Close the requestor.

If an application tries to close a requestor that is already closed, the call is ignored.

Note: When an application closes a requestor, the associated session does not close as well. In this respect, XMS behaves differently compared to JMS.
Parameters:
requestor (input/output)
On input, the handle for the requestor. On output, the function returns a null handle.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsRequestorCreate – Create Requestor

Interface:
xmsRC xmsRequestorCreate(xmsHSess session,
                         xmsHDest destination,
                         xmsHRequestor *requestor
                         xmsHErrorBlock errorBlock);

Create a requestor.

Parameters:
session (input)
The handle for a session. The session must not be transacted and must have one of the following acknowledgement modes:
  • XMSC_AUTO_ACKNOWLEDGE
  • XMSC_DUPS_OK_ACKNOWLEDGE
destination (input)
The handle for the destination where the application can send request messages.
requestor (output)
The handle for the requestor.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
The session associated with the requestor
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

xmsRequestorRequest – Request

Interface:
xmsRC xmsRequestorRequest(xmsHRequestor requestor,
                          xmsHMsg requestMessage,
                          xmsHMsg *replyMessage,
                          xmsHErrorBlock errorBlock);

Send a request message and then wait for, and receive, a reply from the application that receives the request message.

A call to this function blocks until a reply is received or until the session ends, whichever is the sooner.

Parameters:
requestor (input)
The handle for the requestor.
requestMessage (input)
The handle for the request message.
replyMessage (output)
The handle for the reply message.
errorBlock (input)
The handle for an error block or a null handle.
Thread context:
The session associated with the requestor
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

Terms of Use | Rate this page

Last updated: 7 Dec 2005

© Copyright IBM Corporation 2005. All Rights Reserved.