Skip to content

Commit 4c7a9fe

Browse files
sazzad16sazzad16
committed
Rename timeouts: so->socket and infinite->blocking
1 parent 34270c7 commit 4c7a9fe

File tree

9 files changed

+49
-49
lines changed

9 files changed

+49
-49
lines changed

‎src/main/java/redis/clients/jedis/BinaryJedis.java‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -152,28 +152,28 @@ public BinaryJedis(final String host, final int port, final int timeout, final b
152152
public BinaryJedis(final String host, final int port, final int connectionTimeout,
153153
final int soTimeout) {
154154
this(host, port, DefaultJedisClientConfig.builder()
155-
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout).build());
155+
.withConnectionTimeoutMillis(connectionTimeout).withSocketTimeoutMillis(soTimeout).build());
156156
}
157157

158158
public BinaryJedis(final String host, final int port, final int connectionTimeout,
159159
final int soTimeout, final int infiniteSoTimeout) {
160160
this(host, port, DefaultJedisClientConfig.builder()
161-
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
162-
.withInfiniteSoTimeoutMillis(infiniteSoTimeout).build());
161+
.withConnectionTimeoutMillis(connectionTimeout).withSocketTimeoutMillis(soTimeout)
162+
.withBlockingSocketTimeoutMillis(infiniteSoTimeout).build());
163163
}
164164

165165
public BinaryJedis(final String host, final int port, final int connectionTimeout,
166166
final int soTimeout, final boolean ssl) {
167167
this(host, port, DefaultJedisClientConfig.builder()
168-
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout).withSsl(ssl)
168+
.withConnectionTimeoutMillis(connectionTimeout).withSocketTimeoutMillis(soTimeout).withSsl(ssl)
169169
.build());
170170
}
171171

172172
public BinaryJedis(final String host, final int port, final int connectionTimeout,
173173
final int soTimeout, final boolean ssl, final SSLSocketFactory sslSocketFactory,
174174
final SSLParameters sslParameters, final HostnameVerifier hostnameVerifier) {
175175
this(host, port, DefaultJedisClientConfig.builder()
176-
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout).withSsl(ssl)
176+
.withConnectionTimeoutMillis(connectionTimeout).withSocketTimeoutMillis(soTimeout).withSsl(ssl)
177177
.withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
178178
.withHostnameVerifier(hostnameVerifier).build());
179179
}
@@ -183,16 +183,16 @@ public BinaryJedis(final String host, final int port, final int connectionTimeou
183183
final SSLSocketFactory sslSocketFactory, final SSLParameters sslParameters,
184184
final HostnameVerifier hostnameVerifier) {
185185
this(host, port, DefaultJedisClientConfig.builder()
186-
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
187-
.withInfiniteSoTimeoutMillis(infiniteSoTimeout).withSsl(ssl)
186+
.withConnectionTimeoutMillis(connectionTimeout).withSocketTimeoutMillis(soTimeout)
187+
.withBlockingSocketTimeoutMillis(infiniteSoTimeout).withSsl(ssl)
188188
.withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
189189
.withHostnameVerifier(hostnameVerifier).build());
190190
}
191191

192192
public BinaryJedis(final JedisShardInfo shardInfo) {
193193
this(shardInfo.getHost(), shardInfo.getPort(), DefaultJedisClientConfig.builder()
194194
.withConnectionTimeoutMillis(shardInfo.getConnectionTimeout())
195-
.withSoTimeoutMillis(shardInfo.getSoTimeout()).withUser(shardInfo.getUser())
195+
.withSocketTimeoutMillis(shardInfo.getSoTimeout()).withUser(shardInfo.getUser())
196196
.withPassword(shardInfo.getPassword()).withDatabse(shardInfo.getDb())
197197
.withSsl(shardInfo.getSsl()).withSslSocketFactory(shardInfo.getSslSocketFactory())
198198
.withSslParameters(shardInfo.getSslParameters())
@@ -221,22 +221,22 @@ public BinaryJedis(final URI uri, final int timeout, final SSLSocketFactory sslS
221221

222222
public BinaryJedis(final URI uri, final int connectionTimeout, final int soTimeout) {
223223
this(uri, DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
224-
.withSoTimeoutMillis(soTimeout).build());
224+
.withSocketTimeoutMillis(soTimeout).build());
225225
}
226226

227227
public BinaryJedis(final URI uri, final int connectionTimeout, final int soTimeout,
228228
final SSLSocketFactory sslSocketFactory, final SSLParameters sslParameters,
229229
final HostnameVerifier hostnameVerifier) {
230230
this(uri, DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
231-
.withSoTimeoutMillis(soTimeout).withSslSocketFactory(sslSocketFactory)
231+
.withSocketTimeoutMillis(soTimeout).withSslSocketFactory(sslSocketFactory)
232232
.withSslParameters(sslParameters).withHostnameVerifier(hostnameVerifier).build());
233233
}
234234

235235
public BinaryJedis(final URI uri, final int connectionTimeout, final int soTimeout,
236236
final int infiniteSoTimeout, final SSLSocketFactory sslSocketFactory,
237237
final SSLParameters sslParameters, final HostnameVerifier hostnameVerifier) {
238238
this(uri, DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
239-
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout)
239+
.withSocketTimeoutMillis(soTimeout).withBlockingSocketTimeoutMillis(infiniteSoTimeout)
240240
.withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
241241
.withHostnameVerifier(hostnameVerifier).build());
242242
}
@@ -248,8 +248,8 @@ public BinaryJedis(final URI uri, JedisClientConfig config) {
248248
}
249249
client = new Client(new HostAndPort(uri.getHost(), uri.getPort()), DefaultJedisClientConfig
250250
.builder().withConnectionTimeoutMillis(config.getConnectionTimeoutMillis())
251-
.withSoTimeoutMillis(config.getSoTimeoutMillis())
252-
.withInfiniteSoTimeoutMillis(config.getInfiniteSoTimeoutMillis())
251+
.withSocketTimeoutMillis(config.getSocketTimeoutMillis())
252+
.withBlockingSocketTimeoutMillis(config.getBlockingSocketTimeoutMillis())
253253
.withUser(JedisURIHelper.getUser(uri)).withPassword(JedisURIHelper.getPassword(uri))
254254
.withDatabse(JedisURIHelper.getDBIndex(uri)).withClientName(config.getClientName())
255255
.withSsl(JedisURIHelper.isRedisSSLScheme(uri))

‎src/main/java/redis/clients/jedis/Connection.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ public Connection(final String host, final int port, final boolean ssl,
7272

7373
public Connection(final HostAndPort hostAndPort, final JedisClientConfig clientConfig) {
7474
this(new DefaultJedisSocketFactory(hostAndPort, clientConfig));
75-
this.soTimeout = clientConfig.getSoTimeoutMillis();
76-
this.infiniteSoTimeout = clientConfig.getInfiniteSoTimeoutMillis();
75+
this.soTimeout = clientConfig.getSocketTimeoutMillis();
76+
this.infiniteSoTimeout = clientConfig.getBlockingSocketTimeoutMillis();
7777
}
7878

7979
public Connection(final JedisSocketFactory jedisSocketFactory) {

‎src/main/java/redis/clients/jedis/DefaultJedisClientConfig.java‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
public final class DefaultJedisClientConfig implements JedisClientConfig {
88

99
private final int connectionTimeoutMillis;
10-
private final int soTimeoutMillis;
11-
private final int infiniteSoTimeoutMillis;
10+
private final int socketTimeoutMillis;
11+
private final int blockingSocketTimeoutMillis;
1212

1313
private final String user;
1414
private final String password;
@@ -23,12 +23,12 @@ public final class DefaultJedisClientConfig implements JedisClientConfig {
2323
private final HostAndPortMapper hostAndPortMapper;
2424

2525
private DefaultJedisClientConfig(int connectionTimeoutMillis, int soTimeoutMillis,
26-
int infiniteSoTimeoutMillis, String user, String password, int database, String clientName,
26+
int blockingSocketTimeoutMillis, String user, String password, int database, String clientName,
2727
boolean ssl, SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
2828
HostnameVerifier hostnameVerifier, HostAndPortMapper hostAndPortMapper) {
2929
this.connectionTimeoutMillis = connectionTimeoutMillis;
30-
this.soTimeoutMillis = soTimeoutMillis;
31-
this.infiniteSoTimeoutMillis = infiniteSoTimeoutMillis;
30+
this.socketTimeoutMillis = soTimeoutMillis;
31+
this.blockingSocketTimeoutMillis = blockingSocketTimeoutMillis;
3232
this.user = user;
3333
this.password = password;
3434
this.database = database;
@@ -46,13 +46,13 @@ public int getConnectionTimeoutMillis() {
4646
}
4747

4848
@Override
49-
public int getSoTimeoutMillis() {
50-
return soTimeoutMillis;
49+
public int getSocketTimeoutMillis() {
50+
return socketTimeoutMillis;
5151
}
5252

5353
@Override
54-
public int getInfiniteSoTimeoutMillis() {
55-
return infiniteSoTimeoutMillis;
54+
public int getBlockingSocketTimeoutMillis() {
55+
return blockingSocketTimeoutMillis;
5656
}
5757

5858
@Override
@@ -107,8 +107,8 @@ public static Builder builder() {
107107
public static class Builder {
108108

109109
private int connectionTimeoutMillis = Protocol.DEFAULT_TIMEOUT;
110-
private int soTimeoutMillis = Protocol.DEFAULT_TIMEOUT;
111-
private int infiniteSoTimeoutMillis = 0;
110+
private int socketTimeoutMillis = Protocol.DEFAULT_TIMEOUT;
111+
private int blockingSocketTimeoutMillis = 0;
112112

113113
private String user = null;
114114
private String password = null;
@@ -126,8 +126,8 @@ private Builder() {
126126
}
127127

128128
public DefaultJedisClientConfig build() {
129-
return new DefaultJedisClientConfig(connectionTimeoutMillis, soTimeoutMillis,
130-
infiniteSoTimeoutMillis, user, password, databse, clientName, ssl, sslSocketFactory,
129+
return new DefaultJedisClientConfig(connectionTimeoutMillis, socketTimeoutMillis,
130+
blockingSocketTimeoutMillis, user, password, databse, clientName, ssl, sslSocketFactory,
131131
sslParameters, hostnameVerifier, hostAndPortMapper);
132132
}
133133

@@ -136,13 +136,13 @@ public Builder withConnectionTimeoutMillis(int connectionTimeoutMillis) {
136136
return this;
137137
}
138138

139-
public Builder withSoTimeoutMillis(int soTimeoutMillis) {
140-
this.soTimeoutMillis = soTimeoutMillis;
139+
public Builder withSocketTimeoutMillis(int socketTimeoutMillis) {
140+
this.socketTimeoutMillis = socketTimeoutMillis;
141141
return this;
142142
}
143143

144-
public Builder withInfiniteSoTimeoutMillis(int infiniteSoTimeoutMillis) {
145-
this.infiniteSoTimeoutMillis = infiniteSoTimeoutMillis;
144+
public Builder withBlockingSocketTimeoutMillis(int blockingSocketTimeoutMillis) {
145+
this.blockingSocketTimeoutMillis = blockingSocketTimeoutMillis;
146146
return this;
147147
}
148148

@@ -194,7 +194,7 @@ public Builder withHostAndPortMapper(HostAndPortMapper hostAndPortMapper) {
194194

195195
public static DefaultJedisClientConfig copyConfig(JedisClientConfig copy) {
196196
return new DefaultJedisClientConfig(copy.getConnectionTimeoutMillis(),
197-
copy.getSoTimeoutMillis(), copy.getInfiniteSoTimeoutMillis(), copy.getUser(),
197+
copy.getSocketTimeoutMillis(), copy.getBlockingSocketTimeoutMillis(), copy.getUser(),
198198
copy.getPassword(), copy.getDatabase(), copy.getClientName(), copy.isSsl(),
199199
copy.getSslSocketFactory(), copy.getSslParameters(), copy.getHostnameVerifier(),
200200
copy.getHostAndPortMapper());

‎src/main/java/redis/clients/jedis/DefaultJedisSocketFactory.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public class DefaultJedisSocketFactory implements JedisSocketFactory {
1818

1919
private HostAndPort hostAndPort = DEFAULT_HOST_AND_PORT;
2020
private int connectionTimeout = Protocol.DEFAULT_TIMEOUT;
21-
private int soTimeout = Protocol.DEFAULT_TIMEOUT;
21+
private int socketTimeout = Protocol.DEFAULT_TIMEOUT;
2222
private boolean ssl = false;
2323
private SSLSocketFactory sslSocketFactory = null;
2424
private SSLParameters sslParameters = null;
@@ -33,12 +33,12 @@ public DefaultJedisSocketFactory(HostAndPort hostAndPort) {
3333
}
3434

3535
@Deprecated
36-
public DefaultJedisSocketFactory(String host, int port, int connectionTimeout, int soTimeout,
36+
public DefaultJedisSocketFactory(String host, int port, int connectionTimeout, int socketTimeout,
3737
boolean ssl, SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
3838
HostnameVerifier hostnameVerifier) {
3939
this.hostAndPort = new HostAndPort(host, port);
4040
this.connectionTimeout = connectionTimeout;
41-
this.soTimeout = soTimeout;
41+
this.socketTimeout = socketTimeout;
4242
this.ssl = ssl;
4343
this.sslSocketFactory = sslSocketFactory;
4444
this.sslParameters = sslParameters;
@@ -49,7 +49,7 @@ public DefaultJedisSocketFactory(HostAndPort hostAndPort, JedisClientConfig conf
4949
this.hostAndPort = hostAndPort;
5050
if (config != null) {
5151
this.connectionTimeout = config.getConnectionTimeoutMillis();
52-
this.soTimeout = config.getSoTimeoutMillis();
52+
this.socketTimeout = config.getSocketTimeoutMillis();
5353
this.ssl = config.isSsl();
5454
this.sslSocketFactory = config.getSslSocketFactory();
5555
this.sslParameters = config.getSslParameters();
@@ -162,12 +162,12 @@ public void setConnectionTimeout(int connectionTimeout) {
162162

163163
@Override
164164
public int getSoTimeout() {
165-
return this.soTimeout;
165+
return this.socketTimeout;
166166
}
167167

168168
@Override
169169
public void setSoTimeout(int soTimeout) {
170-
this.soTimeout = soTimeout;
170+
this.socketTimeout = soTimeout;
171171
}
172172

173173
public boolean isSsl() {

‎src/main/java/redis/clients/jedis/JedisClientConfig.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ default int getConnectionTimeoutMillis() {
1616
/**
1717
* @return Socket timeout in milliseconds
1818
*/
19-
default int getSoTimeoutMillis() {
19+
default int getSocketTimeoutMillis() {
2020
return Protocol.DEFAULT_TIMEOUT;
2121
}
2222

2323
/**
2424
* @return Socket timeout (in milliseconds) to use during blocking operation. Default is '0',
2525
* which means to block forever.
2626
*/
27-
default int getInfiniteSoTimeoutMillis() {
27+
default int getBlockingSocketTimeoutMillis() {
2828
return 0;
2929
}
3030

‎src/main/java/redis/clients/jedis/JedisClusterConnectionHandler.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ public JedisClusterConnectionHandler(Set<HostAndPort> nodes,
7575
SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
7676
HostnameVerifier hostnameVerifier, JedisClusterHostAndPortMap portMap) {
7777
this(nodes, DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
78-
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout)
78+
.withSocketTimeoutMillis(soTimeout).withBlockingSocketTimeoutMillis(infiniteSoTimeout)
7979
.withUser(user).withPassword(password).withClientName(clientName).withSsl(ssl)
8080
.withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
8181
.withHostnameVerifier(hostnameVerifier).build(), poolConfig, DefaultJedisClientConfig
82-
.builder().withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
83-
.withInfiniteSoTimeoutMillis(infiniteSoTimeout).withUser(user).withPassword(password)
82+
.builder().withConnectionTimeoutMillis(connectionTimeout).withSocketTimeoutMillis(soTimeout)
83+
.withBlockingSocketTimeoutMillis(infiniteSoTimeout).withUser(user).withPassword(password)
8484
.withClientName(clientName).withSsl(ssl).withSslSocketFactory(sslSocketFactory)
8585
.withSslParameters(sslParameters).withHostnameVerifier(hostnameVerifier)
8686
.withHostAndPortMapper(portMap).build());

‎src/main/java/redis/clients/jedis/JedisClusterInfoCache.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ public JedisClusterInfoCache(final GenericObjectPoolConfig<Jedis> poolConfig,
124124
SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
125125
HostnameVerifier hostnameVerifier, HostAndPortMapper hostAndPortMap) {
126126
this(poolConfig, DefaultJedisClientConfig.builder()
127-
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
128-
.withInfiniteSoTimeoutMillis(infiniteSoTimeout).withUser(user).withPassword(password)
127+
.withConnectionTimeoutMillis(connectionTimeout).withSocketTimeoutMillis(soTimeout)
128+
.withBlockingSocketTimeoutMillis(infiniteSoTimeout).withUser(user).withPassword(password)
129129
.withClientName(clientName).withSsl(ssl).withSslSocketFactory(sslSocketFactory)
130130
.withSslParameters(sslParameters).withHostnameVerifier(hostnameVerifier)
131131
.withHostAndPortMapper(hostAndPortMap).build());

‎src/main/java/redis/clients/jedis/JedisFactory.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class JedisFactory implements PooledObjectFactory<Jedis> {
6868
final SSLParameters sslParameters, final HostnameVerifier hostnameVerifier) {
6969
this.hostAndPort.set(new HostAndPort(host, port));
7070
this.config = DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
71-
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout).withUser(user)
71+
.withSocketTimeoutMillis(soTimeout).withBlockingSocketTimeoutMillis(infiniteSoTimeout).withUser(user)
7272
.withPassword(password).withDatabse(database).withClientName(clientName)
7373
.withSsl(ssl).withSslSocketFactory(sslSocketFactory)
7474
.withSslParameters(sslParameters).withHostnameVerifier(hostnameVerifier).build();
@@ -94,7 +94,7 @@ class JedisFactory implements PooledObjectFactory<Jedis> {
9494
}
9595
this.hostAndPort.set(new HostAndPort(uri.getHost(), uri.getPort()));
9696
this.config = DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
97-
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout)
97+
.withSocketTimeoutMillis(soTimeout).withBlockingSocketTimeoutMillis(infiniteSoTimeout)
9898
.withUser(JedisURIHelper.getUser(uri)).withPassword(JedisURIHelper.getPassword(uri))
9999
.withDatabse(JedisURIHelper.getDBIndex(uri)).withClientName(clientName)
100100
.withSsl(JedisURIHelper.isRedisSSLScheme(uri)).withSslSocketFactory(sslSocketFactory)

‎src/test/java/redis/clients/jedis/tests/JedisClusterTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -632,7 +632,7 @@ public void testJedisClusterTimeout() {
632632
public void testJedisClusterTimeoutWithConfig() {
633633
HostAndPort hp = nodeInfo1;
634634
try (JedisCluster jc = new JedisCluster(hp, DefaultJedisClientConfig.builder()
635-
.withConnectionTimeoutMillis(4000).withSoTimeoutMillis(4000).withPassword("cluster").build(),
635+
.withConnectionTimeoutMillis(4000).withSocketTimeoutMillis(4000).withPassword("cluster").build(),
636636
DEFAULT_REDIRECTIONS, DEFAULT_POOL_CONFIG)) {
637637

638638
jc.getClusterNodes().values().forEach(pool -> {

0 commit comments

Comments
 (0)