Inheritance diagram for MQRecv:

[legend]

Collaboration diagram for MQRecv:

[legend]

Public Attributes
	SelectCorrelationId
	Message Selection Options: Correlation Id. More...

	SelectMessageId
	Message Selection Options: Message Id. More...

Public Attributes inherited from abstractMQ
	Channel
	Channel Definition Options: Channel Name. More...

	CharSetId
	Message Descriptor Options: Character Set Identifier. More...

	Connection
	Channel Definition Options: Connection name. More...

	Context
	Flag indicating use of message context. More...

	Password
	Channel Definition Options: Password (if any) More...

	PutApplType
	Message Descriptor Options: Put application type. More...

	QMBehavior
	Flag indicating Queue Manager behavior. More...

	QMgr
	Queue Manager name. More...

	QName
	Queue name. More...

	SSLCipherSpec
	Channel Definition Options: SSL Cipher Spec. More...

	Syncpoint
	Flag indicating use of SYNCPOINT. More...

	Transport
	Channel Definition Options: Transport type. More...

	Username
	Channel Definition Options: Username (if any) More...

Private Member Functions
_.Library.Boolean	Get (_.Library.String Message, _.Library.Integer timeout)
	The Get method reads from the queue specified in the Init call. More...

_.Library.Boolean	GetStream (_.Library.Stream stream, _.Library.Integer timeout)
	Identical to Get except the queue message, if any, is returned in a file character stream object. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Attributes inherited from abstractMQ
	ApplIdentityData = None
	Message Descriptor Options: Application Identity. More...

	CorrelationId = None
	Message Descriptor Options: Correlation Id. More...

	MessageId = None
	Message Descriptor Options: Message Id. More...

	ReplyQMgrName = None
	Message Descriptor Options: Reply Q Manager name. More...

	ReplyQName = None
	Message Descriptor Options: Reply Q name. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

For information on using this class, see Using MQ.

The MQRecv class is used to get a message from a queue.

Member Function Documentation

◆ Get()

_.Library.Boolean Get	(	_.Library.String	Message,
		_.Library.Integer	timeout
	)

private

The Get method reads from the queue specified in the Init call.

The method takes one argument, the timeout in milliseconds. The timeout refers to the time required to contact the server. Get is non-blocking (returns immediately whether or not there is a message on the queue).

If Get gives a return code of 0, there was a failure or timeout. The return string is empty. If Get returns 1, the call was successful. The return string is empty or contains a message depending on what the queue contained.

◆ GetStream()

_.Library.Boolean GetStream	(	_.Library.Stream	stream,
		_.Library.Integer	timeout
	)

private

Identical to Get except the queue message, if any, is returned in a file character stream object.

Data is read from the queue into a memory buffer, and the entire message written to the file of the character stream object.

Member Data Documentation

◆ SelectCorrelationId

SelectCorrelationId

Message Selection Options: Correlation Id.

◆ SelectMessageId

SelectMessageId

Message Selection Options: Message Id.

Public Attributes

Private Member Functions