com.game.netty.transform.BodyTransformer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of game-netty Show documentation

library to simplify using tcp/websocket with netty, especially for game

The newest version!

/*
 * Copyright 2020 Long Huihu
 *
 * 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 com.game.netty.transform;

import io.netty.buffer.ByteBuf;

/**
 * Transform the message body.
 * 
 * Transforming maybe compress, encrypt...
 * 

 * the msgBuf parameter must be a complete message with two condition
 * 1. the readIndex point to the begin of the length field
 * 2. the memory type is heap（as transformer may need extend buf）
 * 
 * on transformBody finished, the bodyBuf's readIndex is not changed, but content length may be changed
 */
public interface BodyTransformer {

    void transformBody(long messageHead, ByteBuf bodyBuf);
}