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 * Message sent to forget about a fid (i.e. close a file)
33 *
34 * @author Jon Blower
35 * $Revision: 146 $
36 * $Date: 2005-03-15 09:01:48 +0000 (Tue, 15 Mar 2005) $
37 * $Log$
38 * Revision 1.4 2005/03/15 09:01:48 jonblower
39 * Message type now stored as short, not int
40 *
41 * Revision 1.3 2005/03/11 14:02:15 jonblower
42 * Merged MINA-Test_20059309 into main line of development
43 *
44 * Revision 1.2.2.1 2005/03/10 11:50:59 jonblower
45 * Changed to fit with MINA framework
46 *
47 * Revision 1.2 2005/02/24 07:44:43 jonblower
48 * Added getFriendlyString()
49 *
50 * Revision 1.1.1.1 2005/02/16 18:58:28 jonblower
51 * Initial import
52 *
53 */
54 public class TclunkMessage extends StyxMessage
55 {
56
57 private long fid;
58
59 /***
60 * Creates a new TclunkMessage. This constructor will be called by the
61 * MessageRecognizer.
62 * @param length The total length of the message (including all header info)
63 * @param type The type of the message (a number between 100 and 127)
64 * @param tag The tag that identifies this message
65 */
66 public TclunkMessage(int length, short type, int tag)
67 {
68 super(length, type, tag);
69 this.name = "Tclunk";
70 }
71
72 public TclunkMessage(long fid)
73 {
74 this(11, (short)120, 0); // The tag will be added later
75 this.fid = fid;
76 }
77
78 protected final void decodeBody(StyxBuffer buf)
79 {
80 this.fid = buf.getUInt();
81 }
82
83 protected final void encodeBody(StyxBuffer buf)
84 {
85 buf.putUInt(this.fid);
86 }
87
88 public long getFid()
89 {
90 return this.fid;
91 }
92
93 protected String getElements()
94 {
95 return ", " + this.fid;
96 }
97
98 public String toFriendlyString()
99 {
100 return "fid: " + this.fid;
101 }
102
103 }