View Javadoc

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  import uk.ac.rdg.resc.jstyx.types.Qid;
32  
33  /***
34   * Message returned by the server in response to a TcreateMessage
35   *
36   * @author Jon Blower
37   * $Revision: 146 $
38   * $Date: 2005-03-15 09:01:48 +0000 (Tue, 15 Mar 2005) $
39   * $Log$
40   * Revision 1.4  2005/03/15 09:01:48  jonblower
41   * Message type now stored as short, not int
42   *
43   * Revision 1.3  2005/03/11 14:02:15  jonblower
44   * Merged MINA-Test_20059309 into main line of development
45   *
46   * Revision 1.2.2.1  2005/03/10 11:50:59  jonblower
47   * Changed to fit with MINA framework
48   *
49   * Revision 1.2  2005/02/24 07:44:43  jonblower
50   * Added getFriendlyString()
51   *
52   * Revision 1.1.1.1  2005/02/16 18:58:26  jonblower
53   * Initial import
54   *
55   */
56  public class RcreateMessage extends StyxMessage
57  {
58      
59      private Qid qid;     // The server's representation of the file to be opened
60      private long ioUnit; // The maximum number of bytes guaranteed to be read from
61                           // or written to the file without breaking into
62                           // multiple Styx messages
63      
64      /*** 
65       * Creates a new RcreateMessage 
66       * @param length The total length of the message (including all header info)
67       * @param type The type of the message (a number between 100 and 127)
68       * @param tag The tag that identifies this message
69       */
70      public RcreateMessage(int length, short type, int tag)
71      {
72          super(length, type, tag);
73          this.name = "Rcreate";
74      }
75      
76      public RcreateMessage(Qid qid, long ioUnit)
77      {
78          this(24, (short)115, 0); // The tag is set later
79          this.qid = qid;
80          this.ioUnit = ioUnit;
81      }
82      
83      protected final void decodeBody(StyxBuffer buf)
84      {
85          this.qid = buf.getQid();  
86          this.ioUnit = buf.getUInt();
87      }
88      
89      protected final void encodeBody(StyxBuffer buf)
90      {
91          buf.putQid(this.qid).putUInt(this.ioUnit);
92      }
93  
94      public Qid getQid()
95      {
96          return qid;
97      }
98  
99      public void setQid(Qid qid)
100     {
101         this.qid = qid;
102     }
103 
104     public long getIoUnit()
105     {
106         return ioUnit;
107     }
108 
109     public void setIoUnit(long ioUnit)
110     {
111         this.ioUnit = ioUnit;
112     }
113     
114     protected String getElements()
115     {
116         return ", " + this.qid + ", " + this.ioUnit;
117     }
118     
119     public String toFriendlyString()
120     {
121         return "qid: " + this.qid.toFriendlyString() + ", I/O Unit: "
122             + this.ioUnit + " bytes";
123     }
124     
125 }