com.mongodb.connection

Class UsageTrackingInternalConnection

java.lang.Object

com.mongodb.connection.UsageTrackingInternalConnection

All Implemented Interfaces:

BufferProvider, InternalConnection

class UsageTrackingInternalConnection
extends java.lang.Object
implements InternalConnection

A connection that tracks when it was opened and when it was last used.

Field Summary

Fields

Modifier and Type	Field and Description
private int	generation
private long	lastUsedAt
private static Logger	LOGGER
private long	openedAt
private InternalConnection	wrapped

Constructor Summary

Constructors

Constructor and Description
UsageTrackingInternalConnection(InternalConnection wrapped, int generation)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
ByteBuf	getBuffer(int size) Gets a buffer with the givens capacity.
ConnectionDescription	getDescription() Gets the description of this connection.
(package private) int	getGeneration() Gets the generation of this connection.
(package private) long	getLastUsedAt() Returns the time at which this connection was last used, or Long.MAX_VALUE if it has not yet been used.
(package private) long	getOpenedAt() Returns the time at which this connection was opened, or Long.MAX_VALUE if it has not yet been opened.
boolean	isClosed() Returns the closed state of the connection
void	open() Opens the connection so its ready for use
void	openAsync(SingleResultCallback<java.lang.Void> callback) Opens the connection so its ready for use
boolean	opened() Returns if the connection has been opened
ResponseBuffers	receiveMessage(int responseTo) Receive a response to a sent message from the server.
void	receiveMessageAsync(int responseTo, SingleResultCallback<ResponseBuffers> callback) Asynchronously receive a response to a sent message from the server.
void	sendMessage(java.util.List<ByteBuf> byteBuffers, int lastRequestId) Send a message to the server.
void	sendMessageAsync(java.util.List<ByteBuf> byteBuffers, int lastRequestId, SingleResultCallback<java.lang.Void> callback) Asynchronously send a message to the server.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

openedAt

private volatile long openedAt

lastUsedAt

private volatile long lastUsedAt

generation

private final int generation

wrapped

private final InternalConnection wrapped

Constructor Detail

UsageTrackingInternalConnection

UsageTrackingInternalConnection(InternalConnection wrapped,
                                int generation)

Method Detail

open

public void open()

Description copied from interface: InternalConnection

Opens the connection so its ready for use

Specified by:

open in interface InternalConnection

openAsync

public void openAsync(SingleResultCallback<java.lang.Void> callback)

Description copied from interface: InternalConnection

Opens the connection so its ready for use

Specified by:

openAsync in interface InternalConnection

Parameters:

callback - the callback to be called once the connection has been opened

close

public void close()

Description copied from interface: InternalConnection

Closes the connection.

Specified by:

close in interface InternalConnection

opened

public boolean opened()

Description copied from interface: InternalConnection

Returns if the connection has been opened

Specified by:

opened in interface InternalConnection

Returns:

true if connection has been opened

isClosed

public boolean isClosed()

Description copied from interface: InternalConnection

Returns the closed state of the connection

Specified by:

isClosed in interface InternalConnection

Returns:

true if connection is closed

getBuffer

public ByteBuf getBuffer(int size)

Description copied from interface: BufferProvider

Gets a buffer with the givens capacity.

Specified by:

getBuffer in interface BufferProvider

Parameters:

size - the size required for the buffer

Returns:

a ByteBuf with the given size, which is now owned by the caller and must be released.

sendMessage

public void sendMessage(java.util.List<ByteBuf> byteBuffers,
                        int lastRequestId)

Description copied from interface: InternalConnection

Send a message to the server. The connection may not make any attempt to validate the integrity of the message.

Specified by:

sendMessage in interface InternalConnection

Parameters:

byteBuffers - the list of byte buffers to send.

lastRequestId - the request id of the last message in byteBuffers

receiveMessage

public ResponseBuffers receiveMessage(int responseTo)

Description copied from interface: InternalConnection

Receive a response to a sent message from the server.

Specified by:

receiveMessage in interface InternalConnection

Parameters:

responseTo - the request id that this message is a response to

Returns:

the response

sendMessageAsync

public void sendMessageAsync(java.util.List<ByteBuf> byteBuffers,
                             int lastRequestId,
                             SingleResultCallback<java.lang.Void> callback)

Description copied from interface: InternalConnection

Asynchronously send a message to the server. The connection may not make any attempt to validate the integrity of the message.

Specified by:

sendMessageAsync in interface InternalConnection

Parameters:

byteBuffers - the list of byte buffers to send

lastRequestId - the request id of the last message in byteBuffers

callback - the callback to invoke on completion

receiveMessageAsync

public void receiveMessageAsync(int responseTo,
                                SingleResultCallback<ResponseBuffers> callback)

Description copied from interface: InternalConnection

Asynchronously receive a response to a sent message from the server.

Specified by:

receiveMessageAsync in interface InternalConnection

Parameters:

responseTo - the request id that this message is a response to

callback - the callback to invoke on completion

getDescription

public ConnectionDescription getDescription()

Description copied from interface: InternalConnection

Gets the description of this connection.

Specified by:

getDescription in interface InternalConnection

Returns:

the connection description

getGeneration

int getGeneration()

Gets the generation of this connection. This can be used by connection pools to track whether the connection is stale.

Returns:

the generation.

getOpenedAt

long getOpenedAt()

Returns the time at which this connection was opened, or Long.MAX_VALUE if it has not yet been opened.

Returns:

the time when this connection was opened, in milliseconds since the epoch.

getLastUsedAt

long getLastUsedAt()

Returns the time at which this connection was last used, or Long.MAX_VALUE if it has not yet been used.

Returns:

the time when this connection was last used, in milliseconds since the epoch.