WebSphere WebSphere Business Integration Message Service Clients for C/C++ Version 1.2.7 and .NET Version 1.2.6 Operating Systems: AIX, Linux, Solaris, Windows

Requestor

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

Inheritance hierarchy:
xms::PropertyContext
   |
   +----xms::Requestor

Constructors

Summary of constructors:
Constructor Description
Requestor Create a requestor.

Requestor – Create Requestor

Interface:
Requestor(const Session & session,
          const Destination & destination);

Create a requestor.

Parameters:
session (input)
A Session object. The session must not be transacted and must have one of the following acknowledgement modes:
  • XMSC_AUTO_ACKNOWLEDGE
  • XMSC_DUPS_OK_ACKNOWLEDGE
destination (input)
A Destination object representing the destination where the application can send request messages.
Thread context:
The session associated with the requestor
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Methods

Summary of methods:
Method Description
close Close the requestor.
getHandle Get the handle that a C application would use to access the requestor.
isNull Determine whether the Requestor object is a null object.
request Send a request message and then wait for, and receive, a reply from the application that receives the request message.

close – Close Requestor

Interface:
xmsVOID close();

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:
None
Returns:
Void
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getHandle – Get Handle

Interface:
xmsHRequestor getHandle() const;

Get the handle that a C application would use to access the requestor.

Parameters:
None
Returns:
The handle for the requestor.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

isNull – Check Whether Null

Interface:
xmsBOOL isNull() const;

Determine whether the Requestor object is a null object.

Parameters:
None
Returns:
  • xmsTRUE, if the Requestor object is a null object.
  • xmsFALSE, if the Requestor object is not a null object.
Thread context:
Any
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

request – Request

Interface:
Message * request(const Message & requestMessage) const;

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

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

Parameters:
requestMessage (input)
The Message object encapsulating the request message.
Returns:
A pointer to the Message object encapsulating the reply message.
Thread context:
The session associated with the requestor
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Inherited methods


Reference topic

Terms of Use | Rate this page

Last updated: 18 Jun 2008

© Copyright IBM Corporation 2005, 2008. All Rights Reserved.