Package com.mongodb.event

Class ConnectionCheckedOutEvent

java.lang.Object

com.mongodb.event.ConnectionCheckedOutEvent

public final class ConnectionCheckedOutEvent
extends Object

An event for checking out a connection from the pool. Such a connection is considered in use until it becomes available.

Since:

3.5

Constructor Summary

Constructors

Constructor	Description
ConnectionCheckedOutEvent(ConnectionId connectionId)	Deprecated. Prefer ConnectionCheckedOutEvent(ConnectionId, long).
ConnectionCheckedOutEvent(ConnectionId connectionId, long operationId)	Deprecated. Prefer ConnectionCheckedOutEvent(ConnectionId, long, long).
ConnectionCheckedOutEvent(ConnectionId connectionId, long operationId, 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 check out the connection.
long	getOperationId()	Gets the operation identifier
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectionCheckedOutEvent

public ConnectionCheckedOutEvent(ConnectionId connectionId,
 long operationId,
 long elapsedTimeNanos)

Constructs an instance.

Parameters:

connectionId - The connection ID. See getConnectionId().

operationId - The operation ID. See getOperationId().

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

Since:

4.11

ConnectionCheckedOutEvent

@Deprecated
public ConnectionCheckedOutEvent(ConnectionId connectionId,
 long operationId)

Deprecated.

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

Construct an instance

Parameters:

connectionId - the connectionId

operationId - the operation id

Since:

4.10

ConnectionCheckedOutEvent

@Deprecated
public ConnectionCheckedOutEvent(ConnectionId connectionId)

Deprecated.

Prefer ConnectionCheckedOutEvent(ConnectionId, long). If this constructor is used, then getOperationId() is -1.

Construct an instance

Parameters:

connectionId - the connectionId

Method Details

getConnectionId

public ConnectionId getConnectionId()

Gets the connection id

Returns:

the connection id

getOperationId

public long getOperationId()

Gets the operation identifier

Returns:

the operation identifier

Since:

4.10

getElapsedTime

public long getElapsedTime(TimeUnit timeUnit)

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

Naturally, if a new connection was not created and established as part of checking out, this duration is usually not greater than ConnectionPoolSettings.getMaxWaitTime(TimeUnit), but may occasionally be greater than that, because the driver does not provide hard real-time guarantees.

This duration does not currently include the time to deliver the ConnectionCheckOutStartedEvent. 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