View Javadoc
1   /*
2    * Copyright 2014 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec.stomp;
17  
18  import io.netty.buffer.ByteBuf;
19  import io.netty.buffer.ByteBufHolder;
20  import io.netty.channel.ChannelPipeline;
21  
22  /**
23   * An STOMP chunk which is used for STOMP chunked transfer-encoding. {@link StompSubframeDecoder} generates
24   * {@link StompContentSubframe} after {@link StompHeadersSubframe} when the content is large or the encoding of
25   * the content is 'chunked.  If you prefer not to receive multiple {@link StompSubframe}s for a single
26   * {@link StompFrame}, place {@link StompSubframeAggregator} after {@link StompSubframeDecoder} in the
27   * {@link ChannelPipeline}.
28   */
29  public interface StompContentSubframe extends ByteBufHolder, StompSubframe {
30      @Override
31      StompContentSubframe copy();
32  
33      @Override
34      StompContentSubframe duplicate();
35  
36      @Override
37      StompContentSubframe retainedDuplicate();
38  
39      @Override
40      StompContentSubframe replace(ByteBuf content);
41  
42      @Override
43      StompContentSubframe retain();
44  
45      @Override
46      StompContentSubframe retain(int increment);
47  
48      @Override
49      StompContentSubframe touch();
50  
51      @Override
52      StompContentSubframe touch(Object hint);
53  }