com.allanbank.mongodb.client.message

Class PendingMessage

java.lang.Object

com.allanbank.mongodb.client.message.PendingMessage

public class PendingMessage
extends Object

Container for a pending message. Before the message is sent the message id will be zero. After it will contain the assigned message id for the connection.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2014, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors

Constructor and Description
PendingMessage() Create a new PendingMessage.
PendingMessage(int messageId, Message message) Create a new PendingMessage.
PendingMessage(int messageId, Message message, ReplyCallback replyCallback) Create a new PendingMessage.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the state of the message allowing the referenced objects to be garbage collected.
Message	getMessage() Returns the sent message.
int	getMessageId() Returns the message id assigned to the sent message.
ReplyCallback	getReplyCallback() Returns the callback for the reply to the message.
long	latency() Determines the latency of the message in nano-seconds.
void	set(int messageId, Message message, ReplyCallback replyCallback) Sets the state of the pending message.
void	set(PendingMessage other) Sets the state of the pending message.
void	timestampNow() Sets the time stamp of the message to now.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PendingMessage

public PendingMessage()

Create a new PendingMessage.

PendingMessage

public PendingMessage(int messageId,
              Message message)

Create a new PendingMessage.

Parameters:

messageId - The id assigned to the message.

message - The sent message.

PendingMessage

public PendingMessage(int messageId,
              Message message,
              ReplyCallback replyCallback)

Create a new PendingMessage.

Parameters:

messageId - The id assigned to the message.

message - The sent message.

replyCallback - The callback for the reply to the message.

Method Detail

clear

public void clear()

Clears the state of the message allowing the referenced objects to be garbage collected.

getMessage

public Message getMessage()

Returns the sent message.

Returns:

The sent message.

getMessageId

public int getMessageId()

Returns the message id assigned to the sent message.

Returns:

The message id assigned to the sent message.

getReplyCallback

public ReplyCallback getReplyCallback()

Returns the callback for the reply to the message.

Returns:

The callback for the reply to the message.

latency

public long latency()

Determines the latency of the message in nano-seconds. If the message does not have a time stamp then zero is returned.

Returns:

The current latency for the message.

set

public void set(int messageId,
       Message message,
       ReplyCallback replyCallback)

Sets the state of the pending message.

Parameters:

messageId - The id of the sent message.

message - The sent message.

replyCallback - The callback for the message. May be null.

set

public void set(PendingMessage other)

Sets the state of the pending message.

Parameters:

other - The pending message to copy from.

timestampNow

public void timestampNow()

Sets the time stamp of the message to now.