discord4j.gateway.payload.PayloadReader Maven / Gradle / Ivy

Go to download
/*
 * This file is part of Discord4J.
 *
 * Discord4J is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Discord4J is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Discord4J.  If not, see .
 */
package discord4j.gateway.payload;

import discord4j.gateway.json.GatewayPayload;
import io.netty.buffer.ByteBuf;

/**
 * Strategy for reading from a {@link io.netty.buffer.ByteBuf} and decoding its contents to a {@link
 * discord4j.gateway.json.GatewayPayload}.
 */
public interface PayloadReader {

    /**
     * Read from the input buffer and encode to a single object.
     *
     * @param payload the input byte buffer
     * @return a {@code GatewayPayload} representing the inbound payload
     */
    GatewayPayload read(ByteBuf payload);
}