summaryrefslogtreecommitdiff
path: root/sources/protocols/VSAbstractProtocol.java
blob: 05864fbb6d1af178ac0d112944be38130cd14160 (plain)
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
/*
 * VS is (c) 2008 by Paul C. Buetow
 * vs@dev.buetow.org
 */
package protocols;

import events.internal.*;
import events.*;
import core.*;

/**
 * The Class VSAbstractProtocol.
 */
abstract public class VSAbstractProtocol extends VSAbstractEvent {
    private static final long serialVersionUID = 1L;

    /** The protocol object is a server. */
    private boolean isServer;

    /** The protocol object is a client. */
    private boolean isClient;

    /** The current protocol object's context is a server. */
    private boolean currentContextIsServer;

    /**
     * Send a message.
     *
     * @param message the message to send
     */
    protected void sendMessage(VSMessage message) {
        if (process == null)
            return;

        process.increaseLamportTime();
        process.increaseVectorTime();
        message.init(process, getClassname());
        process.sendMessage(message);
    }

    /**
     * Checks if it's the incorrect protocol
     *
     * @param message the message to check against
     *
     * @return true, if is incorrect protocol
     */
    private final boolean isIncorrectProtocol(VSMessage message) {
        return !message.getProtocolClassname().equals(getClassname());
    }

    /* (non-Javadoc)
     * @see events.VSAbstractEvent#onStart()
     */
    public final void onStart() {
        if (isClient) {
            currentContextIsServer = false;
            onClientStart();
        }
    }

    /**
     * Runs a client schedule
     */
    public final void onClientScheduleStart() {
        if (isClient) {
            currentContextIsServer = false;
            onClientSchedule();
        }
    }

    /**
     * Runs a server schedule
     */
    public final void onServerScheduleStart() {
        if (isServer) {
            currentContextIsServer = true;
            onServerSchedule();
        }
    }

    /**
     * On message recv.
     *
     * @param message the message
     */
    public final void onMessageRecvStart(VSMessage message) {
        if (isIncorrectProtocol(message))
            return;

        if (isServer) {
            currentContextIsServer = true;
            onServerRecv(message);
        }

        if (isClient) {
            currentContextIsServer = false;
            onClientRecv(message);
        }
    }

    /**
     * Sets if is server.
     *
     * @param isServer the is server
     */
    public final void isServer(boolean isServer) {
        this.isServer = isServer;
    }

    /**
     * Checks if is server.
     *
     * @param isServer the is server
     */
    public final boolean isServer() {
        return isServer;
    }

    /**
     * Sets if is client.
     *
     * @param isClient the is client
     */
    public final void isClient(boolean isClient) {
        this.isClient = isClient;
    }

    /**
     * Checks if is client.
     *
     * @param isClient the is client
     */
    public final boolean isClient() {
        return isClient;
    }

    /**
     * Reset.
     */
    public void reset() {
        if (isServer) {
            currentContextIsServer = true;
            isServer = false;
            onServerReset();
        }

        if (isClient) {
            currentContextIsServer = false;
            isClient = false;
            onClientReset();
        }
    }

    /**
     * Reschedules the protocol for a new time and runs onClientSchedule or onServerSchedule
     *
     * @param isClient the is client
     */
    protected final void scheduleAt(long time) {
        VSAbstractEvent scheduleEvent = new ProtocolScheduleEvent(this, currentContextIsServer);
        VSTask scheduleTask = new VSTask(time, process, scheduleEvent, VSTask.LOCAL);
        process.getSimulationCanvas().getTaskManager().addTask(scheduleTask);
    }

    /**
     * On client start.
     */
    abstract protected void onClientStart();

    /**
     * On client reset.
     */
    abstract protected void onClientReset();

    /**
     * On client schedule.
     */
    abstract protected void onClientSchedule();

    /**
     * On client recv.
     *
     * @param message the message
     */
    abstract protected void onClientRecv(VSMessage message);

    /**
     * On server reset.
     */
    abstract protected void onServerReset();

    /**
     * On server recv.
     *
     * @param message the message
     */
    abstract protected void onServerRecv(VSMessage message);

    /**
     * On server schedule.
     */
    abstract protected void onServerSchedule();

    /**
     * Gets the num processes.
     *
     * @return the num processes
     */
    protected int getNumProcesses() {
        if (process == null)
            return 0;

        return process.getSimulationCanvas().getNumProcesses();
    }

    /* (non-Javadoc)
     * @see prefs.VSPrefs#toString()
     */
    public String toString() {
        if (process == null)
            return "";

        StringBuffer buffer = new StringBuffer();

        buffer.append(prefs.getString("lang.protocol"));
        buffer.append(": ");
        buffer.append(getShortname());
        buffer.append(" ");

        if (currentContextIsServer)
            buffer.append(prefs.getString("lang.server"));
        else
            buffer.append(prefs.getString("lang.client"));

        return buffer.toString();
    }
}