Package com.mongodb.event

Class ServerHeartbeatFailedEvent

java.lang.Object

com.mongodb.event.ServerHeartbeatFailedEvent

public final class ServerHeartbeatFailedEvent
extends Object

An event for server heartbeat failures.

Since:

3.3

Constructor Summary

Constructors

Constructor	Description
ServerHeartbeatFailedEvent(ConnectionId connectionId, long elapsedTimeNanos, boolean awaited, Throwable throwable)	Construct an instance.
ServerHeartbeatFailedEvent(ConnectionId connectionId, long elapsedTimeNanos, Throwable throwable)	Deprecated. Prefer ServerHeartbeatFailedEvent(ConnectionId, long, boolean, Throwable)

Method Summary

Modifier and Type	Method	Description
ConnectionId	getConnectionId()	Gets the connectionId.
long	getElapsedTime(TimeUnit timeUnit)	Gets the elapsed time in the given time unit.
Throwable	getThrowable()	Gets the exceptions that caused the failure
boolean	isAwaited()	Gets whether the heartbeat was awaited.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ServerHeartbeatFailedEvent

@Deprecated
public ServerHeartbeatFailedEvent(ConnectionId connectionId,
 long elapsedTimeNanos,
 Throwable throwable)

Deprecated.

Prefer ServerHeartbeatFailedEvent(ConnectionId, long, boolean, Throwable)

Construct an instance.

Parameters:

connectionId - the non-null connectionId

elapsedTimeNanos - the non-negative elapsed time in nanoseconds

throwable - 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 connectionId

elapsedTimeNanos - the non-negative elapsed time in nanoseconds

awaited - true if the response was awaited

throwable - the non-null exception that caused the failure

Since:

4.1

Method Details

getConnectionId

public ConnectionId getConnectionId()

Gets the connectionId.

Returns:

the connectionId

getElapsedTime

public long getElapsedTime(TimeUnit timeUnit)

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, then getElapsedTime(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

public Throwable getThrowable()

Gets the exceptions that caused the failure

Returns:

the exception

toString

public String toString()

Overrides:

toString in class Object