Package com.mongodb.event

Class ConnectionCheckOutFailedEvent

java.lang.Object

com.mongodb.event.ConnectionCheckOutFailedEvent

public final class ConnectionCheckOutFailedEvent
extends Object

An event for when checking out a connection fails.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConnectionCheckOutFailedEvent.Reason	An enumeration of the reasons checking out a connection failed

Constructor Summary

Constructors

Constructor	Description
ConnectionCheckOutFailedEvent(ServerId serverId, long operationId, ConnectionCheckOutFailedEvent.Reason reason)	Deprecated. Prefer ConnectionCheckOutFailedEvent(ServerId, long, Reason, long).
ConnectionCheckOutFailedEvent(ServerId serverId, long operationId, ConnectionCheckOutFailedEvent.Reason reason, long elapsedTimeNanos)	Constructs an instance.
ConnectionCheckOutFailedEvent(ServerId serverId, ConnectionCheckOutFailedEvent.Reason reason)	Deprecated. Prefer ConnectionCheckOutFailedEvent(ServerId, long, Reason) If this constructor is used, then getOperationId() is -1.

Method Summary

Modifier and Type	Method	Description
long	getElapsedTime(TimeUnit timeUnit)	The time it took to check out the connection.
long	getOperationId()	Gets the operation identifier
ConnectionCheckOutFailedEvent.Reason	getReason()	Gets the reason for the check out failure.
ServerId	getServerId()	Gets the server id
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectionCheckOutFailedEvent

public ConnectionCheckOutFailedEvent(ServerId serverId,
 long operationId,
 ConnectionCheckOutFailedEvent.Reason reason,
 long elapsedTimeNanos)

Constructs an instance.

Parameters:

serverId - The server ID. See getServerId().

operationId - The operation ID. See getOperationId().

reason - The reason the connection check out failed. See getReason().

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

Since:

4.11

ConnectionCheckOutFailedEvent

@Deprecated
public ConnectionCheckOutFailedEvent(ServerId serverId,
 long operationId,
 ConnectionCheckOutFailedEvent.Reason reason)

Deprecated.

Prefer ConnectionCheckOutFailedEvent(ServerId, long, Reason, long). If this constructor is used, then getElapsedTime(TimeUnit) is 0.

Construct an instance

Parameters:

serverId - the server id

operationId - the operation id

reason - the reason the connection check out failed

Since:

4.10

ConnectionCheckOutFailedEvent

@Deprecated
public ConnectionCheckOutFailedEvent(ServerId serverId,
 ConnectionCheckOutFailedEvent.Reason reason)

Deprecated.

Prefer ConnectionCheckOutFailedEvent(ServerId, long, Reason) If this constructor is used, then getOperationId() is -1.

Construct an instance

Parameters:

serverId - the server id

reason - the reason the connection check out failed

Method Details

getServerId

public ServerId getServerId()

Gets the server id

Returns:

the server id

getOperationId

public long getOperationId()

Gets the operation identifier

Returns:

the operation identifier

Since:

4.10

getReason

public ConnectionCheckOutFailedEvent.Reason getReason()

Gets the reason for the check out failure.

Returns:

the reason

Since:

4.3

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