discord4j.gateway.json.ShardGatewayPayload 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.json;

import com.fasterxml.jackson.annotation.JsonIgnore;
import discord4j.discordjson.json.gateway.PayloadData;
import discord4j.discordjson.json.gateway.RequestGuildMembers;
import discord4j.discordjson.json.gateway.StatusUpdate;
import discord4j.discordjson.json.gateway.VoiceStateUpdate;
import discord4j.gateway.GatewayClient;

/**
 * Represents a unicast {@link GatewayPayload} meant to execute a Gateway operation targeting a single shard. The
 * routing information is contained in {@link #getShardIndex()} and can be read by {@link GatewayClient}
 * implementations.
 *
 * @param  the type of the event object
 */
public class ShardGatewayPayload extends GatewayPayload {

    @JsonIgnore
    private final int shardIndex;

    public ShardGatewayPayload(GatewayPayload payload, int shardIndex) {
        super(payload.getOp(), payload.getData(), payload.getSequence(), payload.getType());
        this.shardIndex = shardIndex;
    }

    public static ShardGatewayPayload statusUpdate(StatusUpdate data, int shardId) {
        return new ShardGatewayPayload<>(GatewayPayload.statusUpdate(data), shardId);
    }

    public static ShardGatewayPayload voiceStateUpdate(VoiceStateUpdate data, int shardId) {
        return new ShardGatewayPayload<>(GatewayPayload.voiceStateUpdate(data), shardId);
    }

    public static ShardGatewayPayload requestGuildMembers(RequestGuildMembers data, int shardId) {
        return new ShardGatewayPayload<>(GatewayPayload.requestGuildMembers(data), shardId);
    }

    /**
     * Return the shard index this payload is targeted at.
     *
     * @return a 0-based shard index
     */
    @JsonIgnore
    public int getShardIndex() {
        return shardIndex;
    }
}