mirror of
				https://github.com/gyurix1968/guacamole-client.git
				synced 2025-10-30 16:43:22 +00:00 
			
		
		
		
	GUACAMOLE-102: Improve commentary around connection weight methods and variables.
This commit is contained in:
		| @@ -172,22 +172,25 @@ public class ConnectionModel extends ChildObjectModel { | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Sets the connection weight. | ||||
|      * Sets the connection weight for load balancing. | ||||
|      * | ||||
|      * @param connectionWeight | ||||
|      *     The weight of the connection.  null is acceptable, and anything | ||||
|      *     less than one will prevent the connection from being used. | ||||
|      *     The weight of the connection used in load balancing.  | ||||
|      *     The value is not required for the connection (null), and | ||||
|      *     values less than 1 will prevent the connection from being | ||||
|      *     used. | ||||
|      */ | ||||
|     public void setConnectionWeight(Integer connectionWeight) { | ||||
|         this.connectionWeight = connectionWeight; | ||||
|     } | ||||
|  | ||||
|     /** | ||||
|      * Returns the connection weight used in calculating the | ||||
|      * weighted algorithms. | ||||
|      * Returns the connection weight used in applying weighted | ||||
|      * load balancing algorithms. | ||||
|      * | ||||
|      * @return | ||||
|      *     The connection weight as an Integer. | ||||
|      *     The connection weight used in applying weighted | ||||
|      *     load balancing aglorithms. | ||||
|      */ | ||||
|     public Integer getConnectionWeight() { | ||||
|         return connectionWeight; | ||||
|   | ||||
| @@ -117,7 +117,7 @@ public class ModeledConnection extends ModeledChildDirectoryObject<ConnectionMod | ||||
|     public static final String MAX_CONNECTIONS_PER_USER_NAME = "max-connections-per-user"; | ||||
|  | ||||
|     /** | ||||
|      * The connection weight for weighted algorithms. | ||||
|      * The connection weight attribute used for weighted load balancing algorithms. | ||||
|      */ | ||||
|     public static final String CONNECTION_WEIGHT = "weight"; | ||||
|  | ||||
| @@ -412,11 +412,13 @@ public class ModeledConnection extends ModeledChildDirectoryObject<ConnectionMod | ||||
|     } | ||||
|  | ||||
|     /**  | ||||
|      * Returns the weight of the connection, or a default | ||||
|      * of 1 if the weight is undefined. | ||||
|      * Returns the weight of the connection used in applying weighted | ||||
|      * load balancing algorithms, or a default of 1 if the  | ||||
|      * attribute is undefined. | ||||
|      *   | ||||
|      * @return | ||||
|      *     The weight of the connection. | ||||
|      *     The weight of the connection used in applying weighted | ||||
|      *     load balancing algorithms. | ||||
|      */ | ||||
|     public int getConnectionWeight() { | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user