org.objectweb.joram.shared.client.ConsumerReceiveRequest Class Reference

Inherits org.objectweb.joram.shared.client.AbstractJmsRequest.

Inheritance diagram for org.objectweb.joram.shared.client.ConsumerReceiveRequest:

[legend]Collaboration diagram for org.objectweb.joram.shared.client.ConsumerReceiveRequest:

[legend]List of all members.

Public Member Functions
void	setSelector (String selector)
String	getSelector ()
void	setTimeToLive (long timeToLive)
long	getTimeToLive ()
void	setQueueMode (boolean queueMode)
boolean	getQueueMode ()
void	setReceiveAck (boolean receiveAck)
final boolean	getReceiveAck ()
	ConsumerReceiveRequest (String targetName, String selector, long timeToLive, boolean queueMode)
	ConsumerReceiveRequest ()
void	writeTo (OutputStream os) throws IOException
void	readFrom (InputStream is) throws IOException
Protected Member Functions
int	getClassId ()

---

Detailed Description

A ConsumerReceiveRequest is sent by a MessageConsumer when requesting a message.

Definition at line 36 of file ConsumerReceiveRequest.java.

---

Constructor & Destructor Documentation

org.objectweb.joram.shared.client.ConsumerReceiveRequest.ConsumerReceiveRequest	(	String	targetName,
		String	selector,
		long	timeToLive,
		boolean	queueMode
	)

Constructs a ConsumerReceiveRequest.

Parameters:

	targetName	Name of the target queue or subscription.
	selector	The selector for filtering messages, if any.
	timeToLive	Time to live value in milliseconds, negative for infinite.
	queueMode	true if this request is destinated to a queue.

Definition at line 103 of file ConsumerReceiveRequest.java.

org.objectweb.joram.shared.client.ConsumerReceiveRequest.ConsumerReceiveRequest

(

)

Constructs a ConsumerReceiveRequest.

Definition at line 115 of file ConsumerReceiveRequest.java.

---

Member Function Documentation

void org.objectweb.joram.shared.client.ConsumerReceiveRequest.setSelector

(

String

selector

)

Sets the selector.

Definition at line 44 of file ConsumerReceiveRequest.java.

String org.objectweb.joram.shared.client.ConsumerReceiveRequest.getSelector

(

)

Returns the selector for filtering the messages.

Definition at line 49 of file ConsumerReceiveRequest.java.

void org.objectweb.joram.shared.client.ConsumerReceiveRequest.setTimeToLive

(

long

timeToLive

)

Sets the time to live value.

Definition at line 57 of file ConsumerReceiveRequest.java.

long org.objectweb.joram.shared.client.ConsumerReceiveRequest.getTimeToLive

(

)

Returns the time to live value in milliseconds.

Definition at line 62 of file ConsumerReceiveRequest.java.

void org.objectweb.joram.shared.client.ConsumerReceiveRequest.setQueueMode

(

boolean

queueMode

)

Sets the target destination type.

Definition at line 70 of file ConsumerReceiveRequest.java.

boolean org.objectweb.joram.shared.client.ConsumerReceiveRequest.getQueueMode

(

)

Returns true if the request is destinated to a queue.

Definition at line 75 of file ConsumerReceiveRequest.java.

void org.objectweb.joram.shared.client.ConsumerReceiveRequest.writeTo

(

OutputStream

os

)

throws IOException

The object implements the writeTo method to write its contents to the output stream.

Parameters:

os

the stream to write the object to

Reimplemented from org.objectweb.joram.shared.client.AbstractJmsRequest.

Definition at line 127 of file ConsumerReceiveRequest.java.

void org.objectweb.joram.shared.client.ConsumerReceiveRequest.readFrom

(

InputStream

is

)

throws IOException

The object implements the readFrom method to restore its contents from the input stream.

Parameters:

is

the stream to read data from in order to restore the object

Reimplemented from org.objectweb.joram.shared.client.AbstractJmsRequest.

Definition at line 141 of file ConsumerReceiveRequest.java.

---

The documentation for this class was generated from the following file:

• org/objectweb/joram/shared/client/ConsumerReceiveRequest.java

---