Package io.dropwizard.health.check.tcp
Class TcpHealthCheck
java.lang.Object
com.codahale.metrics.health.HealthCheck
io.dropwizard.health.check.tcp.TcpHealthCheck
public class TcpHealthCheck
extends com.codahale.metrics.health.HealthCheck
-
Nested Class Summary
Nested classes/interfaces inherited from class com.codahale.metrics.health.HealthCheck
com.codahale.metrics.health.HealthCheck.Result, com.codahale.metrics.health.HealthCheck.ResultBuilder
-
Constructor Summary
ConstructorsConstructorDescriptionTcpHealthCheck
(@NonNull String host, int port) TcpHealthCheck
(@NonNull String host, int port, Duration connectionTimeout) -
Method Summary
Methods inherited from class com.codahale.metrics.health.HealthCheck
clock, execute
-
Constructor Details
-
TcpHealthCheck
-
TcpHealthCheck
-
-
Method Details
-
check
- Specified by:
check
in classcom.codahale.metrics.health.HealthCheck
- Throws:
IOException
-
tcpCheck
Performs a health check via TCP against an external dependency. By default uses the JavaSocket
API, but can be overridden to allow for different behavior.- Parameters:
host
- the host to check.port
- the port to check.- Returns:
- whether the check was successful or not.
- Throws:
IOException
-