SocketProbeSpec 9.0.0 API

All Implemented Interfaces:

com.intershop.gradle.icm.utils.ProbeSpec , java.io.Serializable
```
public final class SocketProbeSpec
 implements ProbeSpec
                    
```
Describes a SocketProbe.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`SocketProbeSpec.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`hostName`
`private final Integer`	`port`
`private final Duration`	`retryInterval`
`private final Duration`	`retryTimeout`
`public final static SocketProbeSpec.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`SocketProbeSpec(String hostName, Integer port, Duration retryInterval, Duration retryTimeout)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getHostName()`	the host to connect to
`final Integer`	`getPort()`	the port to connect to
`Duration`	`getRetryInterval()`	interval between two attempts
`Duration`	`getRetryTimeout()`	total time after which probing is given up
`Probe`	`createProbe(Logger logger, ProgressLoggerFactory progressLoggerFactory, Function1<Unit, Unit> onSuccess, Function1<Unit, Unit> onFailure)`	Creates the described Probe.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SocketProbeSpec
```
SocketProbeSpec(String hostName, Integer port, Duration retryInterval, Duration retryTimeout)
```
- Method Detail
  - getHostName
```
 final String getHostName()
```
    the host to connect to
  - getPort
```
 final Integer getPort()
```
    the port to connect to
  - getRetryInterval
```
 Duration getRetryInterval()
```
    interval between two attempts
  - getRetryTimeout
```
 Duration getRetryTimeout()
```
    total time after which probing is given up
  - createProbe
```
 Probe createProbe(Logger logger, ProgressLoggerFactory progressLoggerFactory, Function1<Unit, Unit> onSuccess, Function1<Unit, Unit> onFailure)
```
    Creates the described Probe.
    The callbacks are parameters rather than properties of the description on purpose: they are behaviour, they close over the state of the executing task and they are not Serializable, so keeping them in the description would make it unusable as a task input.
    
    Returns:
    
    the probe to execute