2021-03-23 11:51:40 +01:00
|
|
|
/*
|
|
|
|
* This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
|
2024-01-12 10:01:48 +01:00
|
|
|
* Copyright (C) 2016-2024 ViaVersion and contributors
|
2021-03-23 11:51:40 +01:00
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
|
|
* in the Software without restriction, including without limitation the rights
|
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
|
|
* copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
* SOFTWARE.
|
|
|
|
*/
|
2021-04-26 21:35:29 +02:00
|
|
|
package com.viaversion.viaversion.api.connection;
|
2016-03-14 13:40:23 +01:00
|
|
|
|
2021-04-26 20:52:34 +02:00
|
|
|
import com.viaversion.viaversion.api.protocol.ProtocolPipeline;
|
2023-09-25 08:40:13 +02:00
|
|
|
import com.viaversion.viaversion.api.protocol.packet.Direction;
|
2021-04-26 21:16:10 +02:00
|
|
|
import com.viaversion.viaversion.api.protocol.packet.State;
|
2016-03-14 13:40:23 +01:00
|
|
|
import java.util.UUID;
|
2023-02-12 11:44:25 +01:00
|
|
|
import org.checkerframework.checker.nullness.qual.Nullable;
|
2016-03-14 13:40:23 +01:00
|
|
|
|
2021-04-26 22:54:43 +02:00
|
|
|
public interface ProtocolInfo {
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-16 23:05:31 +02:00
|
|
|
/**
|
|
|
|
* Returns the protocol state the user is currently in.
|
|
|
|
*
|
|
|
|
* @return protocol state
|
2023-09-25 08:40:13 +02:00
|
|
|
* @deprecated server and client can be in different states, use {@link #getClientState()} or {@link #getServerState()}
|
2021-04-16 23:05:31 +02:00
|
|
|
*/
|
2023-09-25 08:40:13 +02:00
|
|
|
@Deprecated/*(forRemoval = true)*/
|
|
|
|
default State getState() {
|
|
|
|
return this.getServerState();
|
|
|
|
}
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2023-09-25 08:40:13 +02:00
|
|
|
/**
|
|
|
|
* Returns the protocol state the client is currently in.
|
|
|
|
*
|
|
|
|
* @return the client protocol state
|
|
|
|
*/
|
|
|
|
State getClientState();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the protocol state the server is currently in.
|
|
|
|
*
|
|
|
|
* @return the server protocol state
|
|
|
|
*/
|
|
|
|
State getServerState();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the protocol state for the given direction.
|
|
|
|
*
|
|
|
|
* @param direction protocol direction
|
|
|
|
* @return state for the given direction
|
|
|
|
*/
|
|
|
|
default State getState(final Direction direction) {
|
|
|
|
// Return the state the packet is coming from
|
|
|
|
return direction == Direction.CLIENTBOUND ? this.getServerState() : this.getClientState();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets both client and server state.
|
|
|
|
*
|
|
|
|
* @param state the new protocol state
|
|
|
|
* @see #setClientState(State)
|
|
|
|
* @see #setServerState(State)
|
|
|
|
*/
|
|
|
|
default void setState(final State state) {
|
|
|
|
this.setClientState(state);
|
|
|
|
this.setServerState(state);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the client protocol state.
|
|
|
|
*
|
|
|
|
* @param clientState the new client protocol state
|
|
|
|
*/
|
|
|
|
void setClientState(State clientState);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the server protocol state.
|
|
|
|
*
|
|
|
|
* @param serverState the new server protocol state
|
|
|
|
*/
|
|
|
|
void setServerState(State serverState);
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-16 23:05:31 +02:00
|
|
|
/**
|
|
|
|
* Returns the user's protocol version, or -1 if not set.
|
|
|
|
* This is set during the {@link State#HANDSHAKE} state.
|
|
|
|
*
|
|
|
|
* @return protocol version, or -1 if not set
|
|
|
|
*/
|
2021-04-26 22:54:43 +02:00
|
|
|
int getProtocolVersion();
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-26 22:54:43 +02:00
|
|
|
void setProtocolVersion(int protocolVersion);
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-16 23:05:31 +02:00
|
|
|
/**
|
|
|
|
* Returns the server protocol version the user is connected to, or -1 if not set.
|
|
|
|
* This is set during the {@link State#HANDSHAKE} state.
|
|
|
|
*
|
|
|
|
* @return server protocol version, or -1 if not set
|
|
|
|
*/
|
2021-04-26 22:54:43 +02:00
|
|
|
int getServerProtocolVersion();
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-26 22:54:43 +02:00
|
|
|
void setServerProtocolVersion(int serverProtocolVersion);
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-16 23:05:31 +02:00
|
|
|
/**
|
|
|
|
* Returns the username associated with this connection.
|
|
|
|
* This is set once the connection enters the {@link State#PLAY} state.
|
|
|
|
*
|
|
|
|
* @return username, set when entering the {@link State#PLAY} state
|
|
|
|
*/
|
2021-04-27 13:25:18 +02:00
|
|
|
@Nullable String getUsername();
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-26 22:54:43 +02:00
|
|
|
void setUsername(String username);
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-16 23:05:31 +02:00
|
|
|
/**
|
|
|
|
* Returns the uuid associated with this connection.
|
|
|
|
* This is set once the connection enters the {@link State#PLAY} state.
|
|
|
|
*
|
|
|
|
* @return uuid, set when entering the {@link State#PLAY} state
|
|
|
|
*/
|
2021-04-27 13:25:18 +02:00
|
|
|
@Nullable UUID getUuid();
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-26 22:54:43 +02:00
|
|
|
void setUuid(UUID uuid);
|
2020-04-13 20:58:24 +02:00
|
|
|
|
2021-04-16 23:05:31 +02:00
|
|
|
/**
|
|
|
|
* Returns the user's pipeline.
|
|
|
|
*
|
|
|
|
* @return protocol pipeline
|
|
|
|
*/
|
2021-04-26 22:54:43 +02:00
|
|
|
ProtocolPipeline getPipeline();
|
|
|
|
|
|
|
|
void setPipeline(ProtocolPipeline pipeline);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the user connection this info represents.
|
|
|
|
*
|
|
|
|
* @return user connection
|
|
|
|
*/
|
2023-02-08 14:20:22 +01:00
|
|
|
@Deprecated/*(forRemoval = true)*/
|
2021-04-26 22:54:43 +02:00
|
|
|
UserConnection getUser();
|
2016-03-14 13:40:23 +01:00
|
|
|
}
|