1 /*
2 * Copyright (c) 2005 The University of Reading
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University of Reading, nor the names of the
14 * authors or contributors may be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package uk.ac.rdg.resc.jstyx.messages;
30
31
32 /***
33 * Message sent to abort a previously-sent message
34 *
35 * @author Jon Blower
36 * $Revision: 146 $
37 * $Date: 2005-03-15 09:01:48 +0000 (Tue, 15 Mar 2005) $
38 * $Log$
39 * Revision 1.4 2005/03/15 09:01:48 jonblower
40 * Message type now stored as short, not int
41 *
42 * Revision 1.3 2005/03/11 14:02:15 jonblower
43 * Merged MINA-Test_20059309 into main line of development
44 *
45 * Revision 1.2.2.1 2005/03/10 11:50:59 jonblower
46 * Changed to fit with MINA framework
47 *
48 * Revision 1.2 2005/02/24 07:44:43 jonblower
49 * Added getFriendlyString()
50 *
51 * Revision 1.1.1.1 2005/02/16 18:58:29 jonblower
52 * Initial import
53 *
54 */
55 public class TflushMessage extends StyxMessage
56 {
57
58 private int oldTag;
59
60 /***
61 * Creates a new TflushMessage. This constructor will be called by the
62 * MessageRecognizer.
63 * @param length The total length of the message (including all header info)
64 * @param type The type of the message (a number between 100 and 127)
65 * @param tag The tag that identifies this message
66 */
67 public TflushMessage(int length, short type, int tag)
68 {
69 super(length, type, tag);
70 this.name = "Tflush";
71 }
72
73 /***
74 * @param oldTag The tag of the message to abort
75 */
76 public TflushMessage(int oldTag)
77 {
78 this(9, (short)108, 0); // The tag will be set later
79 this.oldTag = oldTag;
80 }
81
82 protected final void decodeBody(StyxBuffer buf)
83 {
84 this.oldTag = buf.getUShort();
85 }
86
87 protected final void encodeBody(StyxBuffer buf)
88 {
89 buf.putUShort(this.oldTag);
90 }
91
92 public int getOldTag()
93 {
94 return this.oldTag;
95 }
96
97 protected String getElements()
98 {
99 return ", " + this.oldTag;
100 }
101
102 public String toFriendlyString()
103 {
104 return "tag: " + this.oldTag;
105 }
106
107 }