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
|
Implementation of the SCOPE protocol
====================================
Author: Bela Ban
Scopes allow for concurrent delivery of messages sent by the same sender, without having to resort to OOB.
The implementation is done by a protocol called SCOPE, which has to be somewhere above NAKACK and UNICAST.
Scopes do apply to both multicast and unicast messages.
A message is tagged as scoped by calling Message.setScope(short). This will add a SCOPE.ScopeHeader to the message. A
scope is always a short, so we can have ca 32'000 scopes.
The scope can be set *per message*. It should be more or less unique, but doesn't need to be.
All messages with the same scope are delivered in the order in which they were received by the SCOPE protocol. Because
SCOPE resides above NAKACK and UNICAST, all multicast and unicast messages are guaranteed to be received by SCOPE
(a) in order and (b) once and only once.
Messages without a scope header are passed up the stack.
When a message is received by SCOPE, it is examined for a scope header. If none is present, the message is passed up.
When a scope header is present, we grab the scope and fetch the associated queue (MessageQueue). If no queue
exists yet, one will be created.
The message is then added to the end of the queue.
If no thread is currently processing the queue, one will be created (from a thread pool) and assigned to processing
the queue. The thread (QueueThread) will then continually remove messages from the head of the queue and pass them
up the stack.
When no messages are available, the thread is terminated and is placed back to the thread pool.
The thread pool is configurable (min and max threads, plus idle time).
Unused scopes are periodically removed by the ExiryTask, which is run every expiration_interval milliseconds and
removes scopes which have been idle for more than expiration_time milliseconds.
|