Package com.mongodb.event
Class ServerHeartbeatFailedEvent
java.lang.Object
com.mongodb.event.ServerHeartbeatFailedEvent
An event for server heartbeat failures.
- Since:
- 3.3
-
Constructor Summary
ConstructorDescriptionServerHeartbeatFailedEvent
(ConnectionId connectionId, long elapsedTimeNanos, boolean awaited, Throwable throwable) Construct an instance.ServerHeartbeatFailedEvent
(ConnectionId connectionId, long elapsedTimeNanos, Throwable throwable) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionGets the connectionId.long
getElapsedTime
(TimeUnit timeUnit) Gets the elapsed time in the given time unit.Gets the exceptions that caused the failureboolean
Gets whether the heartbeat was awaited.toString()
-
Constructor Details
-
ServerHeartbeatFailedEvent
@Deprecated public ServerHeartbeatFailedEvent(ConnectionId connectionId, long elapsedTimeNanos, Throwable throwable) Deprecated.Construct an instance.- Parameters:
connectionId
- the non-null connectionIdelapsedTimeNanos
- the non-negative elapsed time in nanosecondsthrowable
- the non-null exception that caused the failure
-
ServerHeartbeatFailedEvent
public ServerHeartbeatFailedEvent(ConnectionId connectionId, long elapsedTimeNanos, boolean awaited, Throwable throwable) Construct an instance.- Parameters:
connectionId
- the non-null connectionIdelapsedTimeNanos
- the non-negative elapsed time in nanosecondsawaited
- true if the response was awaitedthrowable
- the non-null exception that caused the failure- Since:
- 4.1
-
-
Method Details
-
getConnectionId
Gets the connectionId.- Returns:
- the connectionId
-
getElapsedTime
Gets the elapsed time in the given time unit.- Parameters:
timeUnit
- the non-null timeUnit- Returns:
- the elapsed time in the given time unit
-
isAwaited
public boolean isAwaited()Gets whether the heartbeat was awaited. If true, thengetElapsedTime(TimeUnit)
reflects the sum of the round trip time to the server and the time that the server waited before sending a response.- Returns:
- whether the response was awaited
- Since:
- 4.1
- Since server release
- 4.4
-
getThrowable
Gets the exceptions that caused the failure- Returns:
- the exception
-
toString
-
ServerHeartbeatFailedEvent(ConnectionId, long, boolean, Throwable)