public class

GetResponse

extends Object
java.lang.Object
   ↳ com.rabbitmq.client.GetResponse

Class Overview

Encapsulates the response from a basicGet(String, boolean) message-retrieval method call - essentially a static bean "holder" with message response data.

Summary

Public Constructors
GetResponse(Envelope envelope, BasicProperties props, byte[] body, int messageCount)
Construct a GetResponse with the specified construction parameters
Public Methods
byte[] getBody()
Get the message body included in this response
Envelope getEnvelope()
Get the Envelope included in this response
int getMessageCount()
Get the server's most recent estimate of the number of messages remaining on the queue.
BasicProperties getProps()
Get the BasicProperties included in this response
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GetResponse (Envelope envelope, BasicProperties props, byte[] body, int messageCount)

Construct a GetResponse with the specified construction parameters

Parameters
envelope the Envelope
props message properties
body the message body
messageCount the server's most recent estimate of the number of messages remaining on the queue

Public Methods

public byte[] getBody ()

Get the message body included in this response

Returns
  • the message body

public Envelope getEnvelope ()

Get the Envelope included in this response

Returns
  • the envelope

public int getMessageCount ()

Get the server's most recent estimate of the number of messages remaining on the queue. This number can only ever be a rough estimate, because of concurrent activity at the server and the delay between the server sending its estimate and the client receiving and processing the message containing the estimate.

According to the AMQP specification, this figure does not include the message being delivered. For example, this field will be zero in the simplest case of a single reader issuing a Basic.Get on a private queue holding a single message (the message being delivered in this GetResponse).

Returns
  • an estimate of the number of messages remaining to be read from the queue

public BasicProperties getProps ()

Get the BasicProperties included in this response

Returns
  • the properties