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.
This commit is contained in:
hajubal
2024-07-01 23:11:58 +09:00
committed by GitHub
parent ee6fd3322c
commit 78ae221fd5
5 changed files with 5 additions and 5 deletions

View File

@@ -23,7 +23,7 @@ package org.springframework.integration.ip;
public interface CommonSocketOptions {
/**
* @param soTimeout The timeout.
* @param soTimeout The timeout, in milliseconds.
* @see java.net.Socket#setSoTimeout(int)
* @see java.net.DatagramSocket#setSoTimeout(int)
*/

View File

@@ -305,7 +305,7 @@ public class TcpConnectionFactoryFactoryBean extends AbstractFactoryBean<Abstrac
}
/**
* @param soTimeout The timeout.
* @param soTimeout The timeout, in milliseconds.
* @see AbstractConnectionFactory#setSoTimeout(int)
*/
public void setSoTimeout(int soTimeout) {

View File

@@ -53,7 +53,7 @@ public abstract class AbstractConnectionFactorySpec
}
/**
* @param soTimeout the timeout socket option.
* @param soTimeout the timeout socket option, in milliseconds.
* @return the spec.
* @see AbstractConnectionFactory#setSoTimeout(int)
*/

View File

@@ -45,7 +45,7 @@ public class UdpInboundChannelAdapterSpec
}
/**
* @param soTimeout set the timeout socket option.
* @param soTimeout set the timeout socket option, in milliseconds.
* @return the spec.
* @see UnicastReceivingChannelAdapter#setSoTimeout(int)
*/

View File

@@ -198,7 +198,7 @@ public abstract class AbstractConnectionFactory extends IntegrationObjectSupport
}
/**
* @param soTimeout the soTimeout to set
* @param soTimeout the soTimeout to set, in milliseconds
*/
public void setSoTimeout(int soTimeout) {
this.soTimeout = soTimeout;