View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.http2.frames;
20  
21  import java.nio.ByteBuffer;
22  
23  public class DataFrame extends Frame
24  {
25      private final int streamId;
26      private final ByteBuffer data;
27      private final boolean endStream;
28      private final int padding;
29  
30      public DataFrame(int streamId, ByteBuffer data, boolean endStream)
31      {
32          this(streamId, data, endStream, 0);
33      }
34  
35      public DataFrame(int streamId, ByteBuffer data, boolean endStream, int padding)
36      {
37          super(FrameType.DATA);
38          this.streamId = streamId;
39          this.data = data;
40          this.endStream = endStream;
41          this.padding = padding;
42      }
43  
44      public int getStreamId()
45      {
46          return streamId;
47      }
48  
49      public ByteBuffer getData()
50      {
51          return data;
52      }
53  
54      public boolean isEndStream()
55      {
56          return endStream;
57      }
58  
59      /**
60       * @return the number of data bytes remaining.
61       */
62      public int remaining()
63      {
64          return data.remaining();
65      }
66  
67      /**
68       * @return the number of bytes used for padding that count towards flow control.
69       */
70      public int padding()
71      {
72          return padding;
73      }
74  
75      @Override
76      public String toString()
77      {
78          return String.format("%s#%d{length:%d,end=%b}", super.toString(), streamId, data.remaining(), endStream);
79      }
80  }