Package com.mongodb.event

Class ConnectionReadyEvent

java.lang.Object

com.mongodb.event.ConnectionReadyEvent

public final class ConnectionReadyEvent
extends Object

An event for when a connection in the pool has finished being established. Such a connection is considered available until it becomes in use or closed.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
ConnectionReadyEvent(ConnectionId connectionId)	Deprecated. Prefer ConnectionReadyEvent(ConnectionId, long).
ConnectionReadyEvent(ConnectionId connectionId, long elapsedTimeNanos)	Constructs an instance.

Method Summary

Modifier and Type	Method	Description
ConnectionId	getConnectionId()	Gets the connection id
long	getElapsedTime(TimeUnit timeUnit)	The time it took to establish the connection.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectionReadyEvent

public ConnectionReadyEvent(ConnectionId connectionId,
 long elapsedTimeNanos)

Constructs an instance.

Parameters:

connectionId - The connection ID. See getConnectionId().

elapsedTimeNanos - The time it took to establish the connection. See getElapsedTime(TimeUnit).

Since:

4.11

ConnectionReadyEvent

@Deprecated
public ConnectionReadyEvent(ConnectionId connectionId)

Deprecated.

Prefer ConnectionReadyEvent(ConnectionId, long). If this constructor is used, then getElapsedTime(TimeUnit) is 0.

Construct an instance

Parameters:

connectionId - the connection id

Method Details

getConnectionId

public ConnectionId getConnectionId()

Gets the connection id

Returns:

the connection id

getElapsedTime

public long getElapsedTime(TimeUnit timeUnit)

The time it took to establish the connection. More specifically, the time elapsed between the ConnectionCreatedEvent emitted by the same checking out and this event.

Naturally, when establishing a connection is part of checking out, this duration is not greater than ConnectionCheckedOutEvent.getElapsedTime(TimeUnit)/ConnectionCheckOutFailedEvent.getElapsedTime(TimeUnit).

This duration does not currently include the time to deliver the ConnectionCreatedEvent. Subject to change.

Parameters:

timeUnit - The time unit of the result. TimeUnit.convert(long, TimeUnit) specifies how the conversion from nanoseconds to timeUnit is done.

Returns:

The time it took to establish the connection.

Since:

4.11

toString

public String toString()

Overrides:

toString in class Object