/
AcknowledgedMessagesSessionExtension.java
171 lines (155 loc) · 6.15 KB
/
AcknowledgedMessagesSessionExtension.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
/*
* Copyright (c) 2008-2018 the original author or authors.
*
* 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 org.cometd.server.ext;
import java.util.HashMap;
import java.util.Map;
import java.util.Queue;
import org.cometd.bayeux.Channel;
import org.cometd.bayeux.Message;
import org.cometd.bayeux.server.ServerMessage;
import org.cometd.bayeux.server.ServerMessage.Mutable;
import org.cometd.bayeux.server.ServerSession;
import org.cometd.bayeux.server.ServerSession.Extension;
import org.cometd.server.ServerSessionImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Tracks the batch id of messages sent to a client.
*/
public class AcknowledgedMessagesSessionExtension implements Extension, ServerSession.DeQueueListener, ServerSession.QueueListener {
private static final Logger _logger = LoggerFactory.getLogger(AcknowledgedMessagesSessionExtension.class);
private final Map<Long, Long> _batches = new HashMap<>();
private final ServerSessionImpl _session;
private final BatchArrayQueue<ServerMessage> _queue;
private long _lastBatch;
public AcknowledgedMessagesSessionExtension(ServerSession session) {
_session = (ServerSessionImpl)session;
_queue = new BatchArrayQueue<>(16, _session.getLock());
_session.setMetaConnectDeliveryOnly(true);
_session.addListener(this);
}
@Override
public boolean rcv(ServerSession from, Mutable message) {
return true;
}
@Override
public boolean rcvMeta(ServerSession session, Mutable message) {
if (Channel.META_CONNECT.equals(message.getChannel())) {
Map<String, Object> ext = message.getExt(false);
if (ext != null) {
Number batchValue = (Number)ext.get("ack");
if (batchValue != null) {
processBatch(batchValue.longValue());
updateAdvice(message);
}
}
}
return true;
}
private void updateAdvice(Mutable message) {
synchronized (_session.getLock()) {
if (!_session.hasNonLazyMessages() && _session.getQueue().size() != _queue.size()) {
Map<String, Object> advice = message.getAdvice(true);
if (advice.get(Message.TIMEOUT_FIELD) == null) {
advice.put(Message.TIMEOUT_FIELD, 0L);
if (_logger.isDebugEnabled()) {
_logger.debug("Forcing advice: { timeout: 0 } for {}", _session);
}
}
}
}
}
protected void processBatch(long batch) {
synchronized (_session.getLock()) {
if (_logger.isDebugEnabled()) {
_logger.debug("Processing batch: last={}, client={}, server={} for {}", _lastBatch, batch, _queue.getBatch(), _session);
}
_lastBatch = batch;
_queue.clearToBatch(batch);
}
}
@Override
public ServerMessage send(ServerSession session, ServerMessage message) {
// Too early to do anything with the message.
// Other extensions and/or listener may modify/veto it.
return message;
}
@Override
public void queued(ServerSession sender, ServerMessage message) {
// This method is called after all the extensions and the other
// listeners, so only here are sure that the message is not vetoed.
synchronized (_session.getLock()) {
_queue.offer(message);
if (_logger.isDebugEnabled()) {
_logger.debug("Stored at batch {} {} for {}", _queue.getBatch(), message, _session);
}
}
}
@Override
public boolean sendMeta(ServerSession to, Mutable message) {
String channel = message.getChannel();
Map<String, Object> ext = message.getExt(true);
if (channel.equals(Channel.META_HANDSHAKE)) {
if (_session.isAllowMessageDeliveryDuringHandshake()) {
long batch = closeBatch();
Map<String, Object> ack = new HashMap<>(3);
ack.put("enabled", true);
ack.put("batch", batch);
ext.put("ack", ack);
if (_logger.isDebugEnabled()) {
_logger.debug("Sending batch {} for {}", batch, _session);
}
} else {
ext.put("ack", Boolean.TRUE);
}
} else if (channel.equals(Channel.META_CONNECT)) {
long batch = closeBatch();
ext.put("ack", batch);
if (_logger.isDebugEnabled()) {
_logger.debug("Sending batch {} for {}", batch, _session);
}
}
return true;
}
private long closeBatch() {
synchronized (_session.getLock()) {
long batch = _queue.getBatch();
_batches.put(Thread.currentThread().getId(), batch);
_queue.nextBatch();
return batch;
}
}
@Override
public void deQueue(ServerSession session, Queue<ServerMessage> queue) {
synchronized (_session.getLock()) {
Long batch = _batches.remove(Thread.currentThread().getId());
if (_logger.isDebugEnabled()) {
_logger.debug("Dequeuing {}/{} messages until batch {} for {}", queue.size(), _queue.size(), batch, _session);
}
queue.clear();
_queue.exportMessagesToBatch(queue, batch);
}
}
protected void importMessages(ServerSessionImpl session) {
synchronized (_session.getLock()) {
_queue.addAll(session.getQueue());
}
}
// Used only in tests.
BatchArrayQueue<ServerMessage> getBatchArrayQueue() {
return _queue;
}
}