forked from hazelcast/hazelcast
/
AbstractClientListenerService.java
391 lines (336 loc) · 16.3 KB
/
AbstractClientListenerService.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
/*
* Copyright (c) 2008-2019, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.client.impl.spi.impl.listener;
import com.hazelcast.client.impl.connection.ClientConnectionManager;
import com.hazelcast.client.impl.connection.nio.ClientConnection;
import com.hazelcast.client.impl.clientside.HazelcastClientInstanceImpl;
import com.hazelcast.client.impl.protocol.ClientMessage;
import com.hazelcast.client.impl.spi.EventHandler;
import com.hazelcast.client.impl.spi.impl.AbstractClientInvocationService;
import com.hazelcast.client.impl.spi.impl.ClientExecutionServiceImpl;
import com.hazelcast.client.impl.spi.impl.ClientInvocation;
import com.hazelcast.client.impl.spi.impl.ClientInvocationFuture;
import com.hazelcast.client.impl.spi.impl.ListenerMessageCodec;
import com.hazelcast.client.impl.spi.ClientListenerService;
import com.hazelcast.client.properties.ClientProperty;
import com.hazelcast.core.HazelcastException;
import com.hazelcast.internal.metrics.StaticMetricsProvider;
import com.hazelcast.internal.metrics.MetricsRegistry;
import com.hazelcast.internal.metrics.Probe;
import com.hazelcast.logging.ILogger;
import com.hazelcast.internal.nio.Connection;
import com.hazelcast.internal.nio.ConnectionListener;
import com.hazelcast.spi.properties.HazelcastProperties;
import com.hazelcast.internal.serialization.SerializationService;
import com.hazelcast.internal.util.EmptyStatement;
import com.hazelcast.internal.util.ExceptionUtil;
import com.hazelcast.internal.util.UuidUtil;
import com.hazelcast.internal.util.executor.SingleExecutorThreadFactory;
import com.hazelcast.internal.util.executor.StripedExecutor;
import com.hazelcast.internal.util.executor.StripedRunnable;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.Callable;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
import static com.hazelcast.internal.metrics.ProbeLevel.MANDATORY;
import static com.hazelcast.internal.util.Preconditions.checkNotNull;
public abstract class AbstractClientListenerService implements ClientListenerService, StaticMetricsProvider, ConnectionListener {
protected final HazelcastClientInstanceImpl client;
protected final SerializationService serializationService;
protected final long invocationTimeoutMillis;
protected final long invocationRetryPauseMillis;
protected final Map<ClientRegistrationKey, Map<Connection, ClientEventRegistration>> registrations
= new ConcurrentHashMap<ClientRegistrationKey, Map<Connection, ClientEventRegistration>>();
final ScheduledExecutorService registrationExecutor;
final ClientConnectionManager clientConnectionManager;
private final ILogger logger;
@Probe(name = "eventHandlerCount", level = MANDATORY)
private final ConcurrentMap<Long, EventHandler> eventHandlerMap
= new ConcurrentHashMap<Long, EventHandler>();
private final StripedExecutor eventExecutor;
AbstractClientListenerService(HazelcastClientInstanceImpl client) {
this.client = client;
this.serializationService = client.getSerializationService();
this.logger = client.getLoggingService().getLogger(ClientListenerService.class);
String name = client.getName();
HazelcastProperties properties = client.getProperties();
int eventQueueCapacity = properties.getInteger(ClientProperty.EVENT_QUEUE_CAPACITY);
int eventThreadCount = properties.getInteger(ClientProperty.EVENT_THREAD_COUNT);
this.eventExecutor = new StripedExecutor(logger, name + ".event", eventThreadCount, eventQueueCapacity, true);
ClassLoader classLoader = client.getClientConfig().getClassLoader();
ThreadFactory threadFactory = new SingleExecutorThreadFactory(classLoader, name + ".eventRegistration-");
this.registrationExecutor = Executors.newSingleThreadScheduledExecutor(threadFactory);
this.clientConnectionManager = client.getConnectionManager();
AbstractClientInvocationService invocationService = (AbstractClientInvocationService) client.getInvocationService();
this.invocationTimeoutMillis = invocationService.getInvocationTimeoutMillis();
this.invocationRetryPauseMillis = invocationService.getInvocationRetryPauseMillis();
}
@Nonnull
@Override
public UUID registerListener(final ListenerMessageCodec codec, final EventHandler handler) {
//This method should not be called from registrationExecutor
assert (!Thread.currentThread().getName().contains("eventRegistration"));
Future<UUID> future = registrationExecutor.submit(new Callable<UUID>() {
@Override
public UUID call() {
UUID userRegistrationId = UuidUtil.newUnsecureUUID();
ClientRegistrationKey registrationKey = new ClientRegistrationKey(userRegistrationId, handler, codec);
registrations.put(registrationKey, new ConcurrentHashMap<Connection, ClientEventRegistration>());
Collection<ClientConnection> connections = clientConnectionManager.getActiveConnections();
for (ClientConnection connection : connections) {
try {
invoke(registrationKey, connection);
} catch (Exception e) {
if (connection.isAlive()) {
deregisterListenerInternal(userRegistrationId);
throw new HazelcastException("Listener can not be added ", e);
}
}
}
return userRegistrationId;
}
});
try {
return future.get();
} catch (Exception e) {
throw ExceptionUtil.rethrow(e);
}
}
@Override
public boolean deregisterListener(@Nullable UUID userRegistrationId) {
//This method should not be called from registrationExecutor
assert (!Thread.currentThread().getName().contains("eventRegistration"));
checkNotNull(userRegistrationId, "Null userRegistrationId is not allowed!");
try {
Future<Boolean> future = registrationExecutor.submit(
() -> deregisterListenerInternal(userRegistrationId));
try {
return future.get();
} catch (Exception e) {
throw ExceptionUtil.rethrow(e);
}
} catch (RejectedExecutionException ignored) {
//RejectedExecutionException executor(hence the client) is already shutdown
//listeners are cleaned up by the server side. We can ignore the exception and return true safely
EmptyStatement.ignore(ignored);
return true;
}
}
@Override
public void provideStaticMetrics(MetricsRegistry registry) {
registry.registerStaticMetrics(this, "listeners");
}
@Probe(level = MANDATORY)
private int eventQueueSize() {
return eventExecutor.getWorkQueueSize();
}
@Probe(level = MANDATORY)
private long eventsProcessed() {
return eventExecutor.processedCount();
}
public void addEventHandler(long callId, EventHandler handler) {
eventHandlerMap.put(callId, handler);
}
public void handleEventMessage(ClientMessage clientMessage) {
try {
eventExecutor.execute(new ClientEventProcessor(clientMessage));
} catch (RejectedExecutionException e) {
logger.warning("Event clientMessage could not be handled", e);
}
}
public void handleEventMessageOnCallingThread(ClientMessage clientMessage) {
long correlationId = clientMessage.getCorrelationId();
EventHandler eventHandler = eventHandlerMap.get(correlationId);
if (eventHandler == null) {
logger.warning("No eventHandler for callId: " + correlationId + ", event: " + clientMessage);
return;
}
eventHandler.handle(clientMessage);
}
protected void invoke(ClientRegistrationKey registrationKey, Connection connection) throws Exception {
//This method should only be called from registrationExecutor
assert (Thread.currentThread().getName().contains("eventRegistration"));
Map<Connection, ClientEventRegistration> registrationMap = registrations.get(registrationKey);
if (registrationMap.containsKey(connection)) {
return;
}
ListenerMessageCodec codec = registrationKey.getCodec();
ClientMessage request = codec.encodeAddRequest(registersLocalOnly());
EventHandler handler = registrationKey.getHandler();
handler.beforeListenerRegister();
ClientInvocation invocation = new ClientInvocation(client, request, null, connection);
invocation.setEventHandler(handler);
ClientInvocationFuture future = invocation.invokeUrgent();
ClientMessage clientMessage;
try {
clientMessage = future.get();
} catch (Exception e) {
throw ExceptionUtil.rethrow(e, Exception.class);
}
UUID serverRegistrationId = codec.decodeAddResponse(clientMessage);
handler.onListenerRegister();
long correlationId = request.getCorrelationId();
ClientEventRegistration registration
= new ClientEventRegistration(serverRegistrationId, correlationId, connection, codec);
registrationMap.put(connection, registration);
}
@Override
public void connectionAdded(final Connection connection) {
//This method should not be called from registrationExecutor
assert (!Thread.currentThread().getName().contains("eventRegistration"));
registrationExecutor.submit(new Runnable() {
@Override
public void run() {
for (ClientRegistrationKey registrationKey : registrations.keySet()) {
invokeFromInternalThread(registrationKey, connection);
}
}
});
}
public void shutdown() {
eventExecutor.shutdown();
ClientExecutionServiceImpl.shutdownExecutor("registrationExecutor", registrationExecutor, logger);
}
public void start() {
clientConnectionManager.addConnectionListener(this);
}
@Override
public void connectionRemoved(final Connection connection) {
//This method should not be called from registrationExecutor
assert (!Thread.currentThread().getName().contains("eventRegistration"));
registrationExecutor.submit(new Runnable() {
@Override
public void run() {
for (Map<Connection, ClientEventRegistration> registrationMap : registrations.values()) {
ClientEventRegistration registration = registrationMap.remove(connection);
if (registration != null) {
removeEventHandler(registration.getCallId());
}
}
}
});
}
//called from ee.
public StripedExecutor getEventExecutor() {
return eventExecutor;
}
//For Testing
public Collection<ClientEventRegistration> getActiveRegistrations(final UUID uuid) {
//This method should not be called from registrationExecutor
assert (!Thread.currentThread().getName().contains("eventRegistration"));
Future<Collection<ClientEventRegistration>> future = registrationExecutor.submit(
new Callable<Collection<ClientEventRegistration>>() {
@Override
public Collection<ClientEventRegistration> call() {
ClientRegistrationKey key = new ClientRegistrationKey(uuid);
Map<Connection, ClientEventRegistration> registrationMap = registrations.get(key);
if (registrationMap == null) {
return Collections.EMPTY_LIST;
}
LinkedList<ClientEventRegistration> activeRegistrations = new LinkedList<ClientEventRegistration>();
for (ClientEventRegistration registration : registrationMap.values()) {
activeRegistrations.add(registration);
}
return activeRegistrations;
}
});
try {
return future.get();
} catch (Exception e) {
throw ExceptionUtil.rethrow(e);
}
}
// used in tests
public Map<ClientRegistrationKey, Map<Connection, ClientEventRegistration>> getRegistrations() {
return Collections.unmodifiableMap(registrations);
}
// used in tests
public Map<Long, EventHandler> getEventHandlers() {
return Collections.unmodifiableMap(eventHandlerMap);
}
private void invokeFromInternalThread(ClientRegistrationKey registrationKey, Connection connection) {
//This method should only be called from registrationExecutor
assert (Thread.currentThread().getName().contains("eventRegistration"));
try {
invoke(registrationKey, connection);
} catch (Exception e) {
logger.warning("Listener " + registrationKey + " can not be added to a new connection: "
+ connection + ", reason: " + e.getMessage());
}
}
abstract boolean registersLocalOnly();
public void removeEventHandler(long callId) {
eventHandlerMap.remove(callId);
}
private Boolean deregisterListenerInternal(@Nullable UUID userRegistrationId) {
//This method should only be called from registrationExecutor
assert (Thread.currentThread().getName().contains("eventRegistration"));
ClientRegistrationKey key = new ClientRegistrationKey(userRegistrationId);
Map<Connection, ClientEventRegistration> registrationMap = registrations.get(key);
if (registrationMap == null) {
return false;
}
boolean successful = true;
for (Iterator<ClientEventRegistration> iterator = registrationMap.values().iterator(); iterator.hasNext(); ) {
ClientEventRegistration registration = iterator.next();
Connection subscriber = registration.getSubscriber();
try {
ListenerMessageCodec listenerMessageCodec = registration.getCodec();
UUID serverRegistrationId = registration.getServerRegistrationId();
ClientMessage request = listenerMessageCodec.encodeRemoveRequest(serverRegistrationId);
new ClientInvocation(client, request, null, subscriber).invoke().get();
removeEventHandler(registration.getCallId());
iterator.remove();
} catch (Exception e) {
if (subscriber.isAlive()) {
successful = false;
logger.warning("Deregistration of listener with ID " + userRegistrationId
+ " has failed to address " + subscriber.getEndPoint(), e);
}
}
}
if (successful) {
registrations.remove(key);
}
return successful;
}
private final class ClientEventProcessor implements StripedRunnable {
final ClientMessage clientMessage;
private ClientEventProcessor(ClientMessage clientMessage) {
this.clientMessage = clientMessage;
}
@Override
public void run() {
handleEventMessageOnCallingThread(clientMessage);
}
@Override
public int getKey() {
return clientMessage.getPartitionId();
}
}
}