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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of discord4j-gateway Show documentation

A JVM-based REST/WS wrapper for the official Discord Bot API

The newest version!

/*
 * 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;
import org.reactivestreams.Publisher;

/**
 * Strategy for encoding a {@link GatewayPayload} and writing its contents to a {@link Publisher} of {@link ByteBuf}.
 */
public interface PayloadWriter {

    /**
     * Write a given payload to the output buffer.
     *
     * @param payload the output payload
     * @return the publisher of outbound {@code ByteBuf}
     */
    Publisher write(GatewayPayload payload);
}