aboutsummaryrefslogtreecommitdiffstats
path: root/messagebus/src/main/java/com/yahoo/messagebus/CallStack.java
blob: a4ff32ed147e50b6122fccf6241b36eefc382e88 (plain) (blame)
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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.messagebus;

import java.util.ArrayDeque;
import java.util.Deque;

/**
 * An wrapper around a stack of frame objects that is aware of the message that owns it. It contains functionality to
 * move the content of itself to another, never to copy, since a callback is unique and might be counted by
 * implementations such as Resender.
 *
 * @author Simon Thoresen Hult
 */
public class CallStack {

    private Deque<StackFrame> stack = new ArrayDeque<>();

    /**
     * Push a handler onto the callstack of this message with a given context.
     *
     * @param handler The reply handler to store.
     * @param context The context to be associated with the message for that handler.
     */
    public void push(ReplyHandler handler, Object context) {
        stack.push(new StackFrame(handler, context));
    }

    /**
     * Pop a frame from this stack. The handler part of the frame will be returned and the context part will be set on
     * the given reply. Invoke this method on an empty stack and terrible things will happen.
     *
     * @param routable The routable that will have its context set.
     * @return The next handler on the stack.
     */
    public ReplyHandler pop(Routable routable) {
        StackFrame frame = stack.pop();
        routable.setContext(frame.context);
        return frame.handler;
    }

    /**
     * Swap the content of this and the argument stack.
     *
     * @param other The stack to swap content with.
     */
    public void swap(CallStack other) {
        Deque<StackFrame> tmp = stack;
        stack = other.stack;
        other.stack = tmp;
    }

    /**
     * Clear this call stack. This method should only be used when you are certain that it is safe to just throw away
     * the stack. It has similar effects to stopping a thread, you need to know where it is safe to do so.
     */
    public void clear() {
        stack.clear();
    }

    /**
     * Returns the number of elements of the callstack.
     *
     * @return The number of elements.
     */
    public int size() {
        return stack.size();
    }

    /**
     * Helper class that holds stack frame data.
     */
    private static class StackFrame {

        private final ReplyHandler handler;
        private final Object context;

        StackFrame(ReplyHandler handler, Object context) {
            this.handler = handler;
            this.context = context;
        }
    }
}