Skip to content

Commit 78ae221

Browse files
authored
Add milliseconds to soTimeout property Javadocs
Connection timeout's unit is specified as `seconds` in the annotation, but `soTimeout` unit is not specified as `milliseconds`, so people who do not know the parameter information of the java socket library may be confused.
1 parent ee6fd33 commit 78ae221

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
public interface CommonSocketOptions {
2424

2525
/**
26-
* @param soTimeout The timeout.
26+
* @param soTimeout The timeout, in milliseconds.
2727
* @see java.net.Socket#setSoTimeout(int)
2828
* @see java.net.DatagramSocket#setSoTimeout(int)
2929
*/

spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ public void setLocalAddress(String localAddress) {
305305
}
306306

307307
/**
308-
* @param soTimeout The timeout.
308+
* @param soTimeout The timeout, in milliseconds.
309309
* @see AbstractConnectionFactory#setSoTimeout(int)
310310
*/
311311
public void setSoTimeout(int soTimeout) {

spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/AbstractConnectionFactorySpec.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public S id(String id) {
5353
}
5454

5555
/**
56-
* @param soTimeout the timeout socket option.
56+
* @param soTimeout the timeout socket option, in milliseconds.
5757
* @return the spec.
5858
* @see AbstractConnectionFactory#setSoTimeout(int)
5959
*/

spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/UdpInboundChannelAdapterSpec.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ protected UdpInboundChannelAdapterSpec(int port, String multicastGroup) {
4545
}
4646

4747
/**
48-
* @param soTimeout set the timeout socket option.
48+
* @param soTimeout set the timeout socket option, in milliseconds.
4949
* @return the spec.
5050
* @see UnicastReceivingChannelAdapter#setSoTimeout(int)
5151
*/

spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ public int getSoTimeout() {
198198
}
199199

200200
/**
201-
* @param soTimeout the soTimeout to set
201+
* @param soTimeout the soTimeout to set, in milliseconds
202202
*/
203203
public void setSoTimeout(int soTimeout) {
204204
this.soTimeout = soTimeout;

0 commit comments

Comments
 (0)