IGNITE-2445: Fixed JavaDocs for ODBC.
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/57822b61 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/57822b61 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/57822b61 Branch: refs/heads/ignite-1786 Commit: 57822b6118a2c22ee17794f32bb55e3370eb4490 Parents: f58ceb6 Author: isapego <[email protected]> Authored: Tue Jan 26 16:09:42 2016 +0300 Committer: isapego <[email protected]> Committed: Tue Jan 26 16:09:42 2016 +0300 ---------------------------------------------------------------------- .../ignite/configuration/IgniteConfiguration.java | 8 ++++++-- .../ignite/configuration/OdbcConfiguration.java | 14 +++++++++++--- 2 files changed, 17 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/57822b61/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java index 656e36c..6a2efcf 100644 --- a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java +++ b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteConfiguration.java @@ -2284,14 +2284,18 @@ public class IgniteConfiguration { } /** - * @return Odbc configuration. + * Gets configuration for ODBC. + * + * @return ODBC configuration. */ public OdbcConfiguration getOdbcConfiguration() { return odbcCfg; } /** - * @param odbcCfg Odbc configuration. + * Sets configuration for ODBC. + * + * @param odbcCfg ODBC configuration. * @return {@code this} for chaining. */ public IgniteConfiguration setOdbcConfiguration(OdbcConfiguration odbcCfg) { http://git-wip-us.apache.org/repos/asf/ignite/blob/57822b61/modules/core/src/main/java/org/apache/ignite/configuration/OdbcConfiguration.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/OdbcConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/OdbcConfiguration.java index 74fe29f..bf4122a 100644 --- a/modules/core/src/main/java/org/apache/ignite/configuration/OdbcConfiguration.java +++ b/modules/core/src/main/java/org/apache/ignite/configuration/OdbcConfiguration.java @@ -151,7 +151,7 @@ public class OdbcConfiguration { } /** - * Sets whether {@code TCP_NODELAY} option should be set for all accepted client connections. + * Sets whether {@code TCP_NODELAY} option should be set for all accepted ODBC client connections. * * @param noDelay {@code True} if option should be enabled. * @see #isNoDelay() @@ -165,6 +165,8 @@ public class OdbcConfiguration { * that is allocated and accessed using native system calls, without using JVM heap. Enabling direct * buffer <em>may</em> improve performance and avoid memory issues (long GC pauses due to huge buffer * size). + * <p/> + * If not specified, default value is {@link #DFLT_TCP_DIRECT_BUF}. * * @return Whether direct buffer should be used. */ @@ -184,6 +186,8 @@ public class OdbcConfiguration { /** * Gets ODBC TCP server send buffer size. + * <p/> + * If not specified, default value is {@link #DFLT_SOCK_BUF_SIZE}. * * @return ODBC TCP server send buffer size (0 for default). */ @@ -203,6 +207,8 @@ public class OdbcConfiguration { /** * Gets ODBC TCP server receive buffer size. + * <p/> + * If not specified, default value is {@link #DFLT_SOCK_BUF_SIZE}. * * @return ODBC TCP server receive buffer size (0 for default). */ @@ -261,10 +267,12 @@ public class OdbcConfiguration { } /** - * Gets idle timeout for ODBC server. + * Gets idle timeout for ODBC TCP server. * <p> * This setting is used to reject half-opened sockets. If no packets * come within idle timeout, the connection is closed. + * <p/> + * If not specified, default value is {@link #DFLT_IDLE_TIMEOUT}. * * @return Idle timeout in milliseconds. */ @@ -273,7 +281,7 @@ public class OdbcConfiguration { } /** - * Sets idle timeout for ODBC server. + * Sets idle timeout for ODBC TCP server. * * @param idleTimeout Idle timeout in milliseconds. * @see #getIdleTimeout()
