netty5/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketFrame.java
Trustin Lee 3a9f472161 Make retained derived buffers recyclable
Related: #4333 #4421 #5128

Motivation:

slice(), duplicate() and readSlice() currently create a non-recyclable
derived buffer instance. Under heavy load, an application that creates a
lot of derived buffers can put the garbage collector under pressure.

Modifications:

- Add the following methods which creates a non-recyclable derived buffer
  - retainedSlice()
  - retainedDuplicate()
  - readRetainedSlice()
- Add the new recyclable derived buffer implementations, which has its
  own reference count value
- Add ByteBufHolder.retainedDuplicate()
- Add ByteBufHolder.replace(ByteBuf) so that..
  - a user can replace the content of the holder in a consistent way
  - copy/duplicate/retainedDuplicate() can delegate the holder
    construction to replace(ByteBuf)
- Use retainedDuplicate() and retainedSlice() wherever possible
- Miscellaneous:
  - Rename DuplicateByteBufTest to DuplicatedByteBufTest (missing 'D')
  - Make ReplayingDecoderByteBuf.reject() return an exception instead of
    throwing it so that its callers don't need to add dummy return
    statement

Result:

Derived buffers are now recycled when created via retainedSlice() and
retainedDuplicate() and derived from a pooled buffer
2016-05-17 11:16:13 +02:00

110 lines
2.8 KiB
Java

/*
* Copyright 2012 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.handler.codec.http.websocketx;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.DefaultByteBufHolder;
import io.netty.util.internal.StringUtil;
/**
* Base class for web socket frames
*/
public abstract class WebSocketFrame extends DefaultByteBufHolder {
/**
* Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
* final fragment.
*/
private final boolean finalFragment;
/**
* RSV1, RSV2, RSV3 used for extensions
*/
private final int rsv;
protected WebSocketFrame(ByteBuf binaryData) {
this(true, 0, binaryData);
}
protected WebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
super(binaryData);
this.finalFragment = finalFragment;
this.rsv = rsv;
}
/**
* Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
* final fragment.
*/
public boolean isFinalFragment() {
return finalFragment;
}
/**
* Bits used for extensions to the standard.
*/
public int rsv() {
return rsv;
}
@Override
public WebSocketFrame copy() {
return (WebSocketFrame) super.copy();
}
@Override
public WebSocketFrame duplicate() {
return (WebSocketFrame) super.duplicate();
}
@Override
public WebSocketFrame retainedDuplicate() {
return (WebSocketFrame) super.retainedDuplicate();
}
@Override
public abstract WebSocketFrame replace(ByteBuf content);
@Override
public String toString() {
return StringUtil.simpleClassName(this) + "(data: " + contentToString() + ')';
}
@Override
public WebSocketFrame retain() {
super.retain();
return this;
}
@Override
public WebSocketFrame retain(int increment) {
super.retain(increment);
return this;
}
@Override
public WebSocketFrame touch() {
super.touch();
return this;
}
@Override
public WebSocketFrame touch(Object hint) {
super.touch(hint);
return this;
}
}