ignite-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sboi...@apache.org
Subject [13/20] incubator-ignite git commit: # IGNITE-709 Add javadoc for client flag.
Date Mon, 25 May 2015 18:50:46 GMT
# IGNITE-709 Add javadoc for client flag.


Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/87fa3106
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/87fa3106
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/87fa3106

Branch: refs/heads/ignite-23
Commit: 87fa310667805db68e568548ee50933132a81a58
Parents: 0d883a9
Author: sevdokimov <sevdokimov@gridgain.com>
Authored: Mon May 25 14:44:24 2015 +0300
Committer: sevdokimov <sevdokimov@gridgain.com>
Committed: Mon May 25 14:44:24 2015 +0300

----------------------------------------------------------------------
 modules/core/src/main/java/org/apache/ignite/Ignition.java  | 9 +++++++--
 .../main/java/org/apache/ignite/cluster/ClusterNode.java    | 5 ++++-
 .../apache/ignite/configuration/IgniteConfiguration.java    | 3 ++-
 3 files changed, 13 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/87fa3106/modules/core/src/main/java/org/apache/ignite/Ignition.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/Ignition.java b/modules/core/src/main/java/org/apache/ignite/Ignition.java
index 6ed99bd..af78c2a 100644
--- a/modules/core/src/main/java/org/apache/ignite/Ignition.java
+++ b/modules/core/src/main/java/org/apache/ignite/Ignition.java
@@ -133,18 +133,23 @@ public class Ignition {
     }
 
     /**
-     * Sets client mode flag.
+     * Sets static client mode flag. This flag used when node is started if {@link IgniteConfiguration#isClientMode()}
+     * is {@code null}.
      *
      * @param clientMode Client mode flag.
+     * @see IgniteConfiguration#isClientMode()
      */
     public static void setClientMode(boolean clientMode) {
         IgnitionEx.setClientMode(clientMode);
     }
 
     /**
-     * Gets client mode flag.
+     * Gets client static mode flag. This flag used when node is started if {@link IgniteConfiguration#isClientMode()}
+     * is {@code null}.
+     * {@link org.apache.ignite.spi.discovery.tcp.TcpClientDiscoverySpi} on client nodes.
      *
      * @return Client mode flag.
+     * @see IgniteConfiguration#isClientMode()
      */
     public static boolean isClientMode() {
         return IgnitionEx.isClientMode();

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/87fa3106/modules/core/src/main/java/org/apache/ignite/cluster/ClusterNode.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/cluster/ClusterNode.java b/modules/core/src/main/java/org/apache/ignite/cluster/ClusterNode.java
index 9cb5d3d..5af4960 100644
--- a/modules/core/src/main/java/org/apache/ignite/cluster/ClusterNode.java
+++ b/modules/core/src/main/java/org/apache/ignite/cluster/ClusterNode.java
@@ -238,9 +238,12 @@ public interface ClusterNode {
     public boolean isDaemon();
 
     /**
-     * Tests whether or not this node is a client node.
+     * Tests whether or not this node is connected to cluster as a client. Do not confuse
client in terms of
+     * discovery {@link org.apache.ignite.spi.discovery.tcp.TcpClientDiscoverySpi} and client
in terms of cache
+     * {@link org.apache.ignite.configuration.IgniteConfiguration#isClientMode()}.
      *
      * @return {@code True} if this node is a client node, {@code false} otherwise.
+     * @see org.apache.ignite.spi.discovery.tcp.TcpClientDiscoverySpi
      */
     public boolean isClient();
 }

http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/87fa3106/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 ebe2b8e..ac919cc 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
@@ -1823,7 +1823,8 @@ public class IgniteConfiguration {
     }
 
     /**
-     * Gets client mode flag.
+     * Gets client mode flag. Client node cannot hold data in the caches. It's recommended
to use
+     * {@link org.apache.ignite.spi.discovery.tcp.TcpClientDiscoverySpi} on client nodes.
      *
      * @return Client mode flag.
      */


Mime
View raw message