From 78ae221fd52e9bfb8d79867d47ac20fd1a396e8a Mon Sep 17 00:00:00 2001
From: hajubal <hajubal@gmail.com>
Date: Mon, 1 Jul 2024 23:11:58 +0900
Subject: [PATCH] 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.
---
 .../org/springframework/integration/ip/CommonSocketOptions.java | 2 +-
 .../integration/ip/config/TcpConnectionFactoryFactoryBean.java  | 2 +-
 .../integration/ip/dsl/AbstractConnectionFactorySpec.java       | 2 +-
 .../integration/ip/dsl/UdpInboundChannelAdapterSpec.java        | 2 +-
 .../ip/tcp/connection/AbstractConnectionFactory.java            | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java
index e1f6070189..0a9f7ec56b 100644
--- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java
+++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java
@@ -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)
 	 */
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java
index 0c29b66307..dc7bba5c7b 100644
--- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java
+++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java
@@ -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) {
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/AbstractConnectionFactorySpec.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/AbstractConnectionFactorySpec.java
index fbd2570805..5dc02bbf2c 100644
--- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/AbstractConnectionFactorySpec.java
+++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/AbstractConnectionFactorySpec.java
@@ -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)
 	 */
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/UdpInboundChannelAdapterSpec.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/UdpInboundChannelAdapterSpec.java
index f7b40f5a55..9dc9fceef2 100644
--- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/UdpInboundChannelAdapterSpec.java
+++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/dsl/UdpInboundChannelAdapterSpec.java
@@ -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)
 	 */
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java
index 55c6da1f63..4007bf5133 100644
--- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java
+++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java
@@ -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;