SourceRcon (Asynchronous Game Query Library 1.2.2 API)

java.lang.Object
- com.ibasco.agql.protocols.valve.source.query.rcon.SourceRcon

```
@ApiStatus.Internal
public final class SourceRcon
extends Object
```
A collection of global constants and utility methods used internally by the RCON module

Author:

Rafael Luis Ibasco

Field Summary

Fields
Modifier and Type	Field and Description
`static ThreadGroup`	`DEFAULT_THREAD_GROUP` Constant `DEFAULT_THREAD_GROUP`
`static io.netty.util.AttributeKey<Boolean>`	`INVALIDATED` Flag indicating that the channel has been invalidated and needs to be re-authenticated
`static int`	`RCON_TERMINATOR_RID` A reserved request id representing a special rcon terminator packet
`static int`	`RCON_TYPE_REQUEST_AUTH` RCON Auth Request Header
`static int`	`RCON_TYPE_REQUEST_COMMAND` RCON Command Request Header
`static int`	`RCON_TYPE_RESPONSE_AUTH` RCON Auth Response Header
`static int`	`RCON_TYPE_RESPONSE_VALUE` RCON Response Value Header
`static int`	`RCON_TYPE_RESPONSE_VALUE_RUST` RCON Response Value Header (Rust)

Constructor Summary

Constructors
Constructor and Description

SourceRcon()

Constructors
Constructor and Description
`SourceRcon()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SourceRconAuthRequest`	`createAuthRequest(byte[] password)` createAuthRequest.
`static SourceRconAuthRequest`	`createAuthRequest(Credentials credentials)` createAuthRequest.
`static int`	`createRequestId()` A utility method to generate random request ids
`static String`	`getPacketTypeName(int type)` getPacketTypeName.
`static String`	`getPacketTypeName(SourceRconPacket packet)` Get the name of the provided `SourceRconPacket`
`static boolean`	`isAuthRequestPacket(SourceRconPacket packet)` Check if packet is an RCON Auth request packet
`static boolean`	`isAuthResponsePacket(SourceRconPacket packet)` Check if packet is an RCON auth response packet
`static boolean`	`isCommandResponsePacket(SourceRconPacket packet)` Check if packet is a Command Response Packet
`static boolean`	`isInitialTerminatorPacket(SourceRconPacket packet)` Check if the packet is the primary terminator packet (The first terminator packet sent after a request)
`static boolean`	`isResponseValuePacket(SourceRconPacket packet)` Check if packet is an RCON response value packet
`static boolean`	`isSecondaryTerminatorPacket(SourceRconPacket packet)` Check if the packet is the secondary terminator packet (The secondary terminator packet sent after a request)
`static boolean`	`isTerminatorId(int requestId)` Checks if the rcon request id represents a terminator packet
`static boolean`	`isTerminatorPacket(SourceRconPacket packet)` Check if packet is a valid terminator packet
`static boolean`	`isValidRequestId(int requestId)` Checks if the request id is within the valid range
`static boolean`	`isValidTerminator(int terminator)` Check if value is valid RCON terminator
`static boolean`	`terminatorPacketEnabled(io.netty.channel.ChannelHandlerContext ctx)` Convenience method to determine if terminator packets are enabled for the provided channel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_THREAD_GROUP
```
public static final ThreadGroup DEFAULT_THREAD_GROUP
```
    Constant DEFAULT_THREAD_GROUP
  - RCON_TYPE_REQUEST_AUTH
```
public static final int RCON_TYPE_REQUEST_AUTH
```
    RCON Auth Request Header
    
    See Also:
    
    Constant Field Values
  - RCON_TYPE_REQUEST_COMMAND
```
public static final int RCON_TYPE_REQUEST_COMMAND
```
    RCON Command Request Header
    
    See Also:
    
    Constant Field Values
  - RCON_TYPE_RESPONSE_AUTH
```
public static final int RCON_TYPE_RESPONSE_AUTH
```
    RCON Auth Response Header
    
    See Also:
    
    Constant Field Values
  - RCON_TYPE_RESPONSE_VALUE
```
public static final int RCON_TYPE_RESPONSE_VALUE
```
    RCON Response Value Header
    
    See Also:
    
    Constant Field Values
  - RCON_TYPE_RESPONSE_VALUE_RUST
```
public static final int RCON_TYPE_RESPONSE_VALUE_RUST
```
    RCON Response Value Header (Rust)
    
    See Also:
    
    Constant Field Values
  - RCON_TERMINATOR_RID
```
public static final int RCON_TERMINATOR_RID
```
    A reserved request id representing a special rcon terminator packet
    
    See Also:
    
    Constant Field Values
  - INVALIDATED
```
public static final io.netty.util.AttributeKey<Boolean> INVALIDATED
```
    Flag indicating that the channel has been invalidated and needs to be re-authenticated
- Constructor Detail
  - SourceRcon
```
public SourceRcon()
```
- Method Detail
  - isInitialTerminatorPacket
```
public static boolean isInitialTerminatorPacket(SourceRconPacket packet)
```
    Check if the packet is the primary terminator packet (The first terminator packet sent after a request)
    
    Parameters:
    
    packet - SourceRconPacket to check
    
    Returns:
    
    true if the rcon packet is the initial terminator packet (byte terminator value of 0x0)
  - isTerminatorPacket
```
public static boolean isTerminatorPacket(SourceRconPacket packet)
```
    Check if packet is a valid terminator packet
    
    Parameters:
    
    packet - The SourceRconPacket to check
    
    Returns:
    
    true if the packet is a terminator packet
  - isTerminatorId
```
public static boolean isTerminatorId(int requestId)
```
    Checks if the rcon request id represents a terminator packet
    
    Parameters:
    
    requestId - An integer representing an Rcon Request Id
    
    Returns:
    
    true if the given id represents a terminator
  - isResponseValuePacket
```
public static boolean isResponseValuePacket(SourceRconPacket packet)
```
    Check if packet is an RCON response value packet
    
    Parameters:
    
    packet - The SourceRconPacket to check
    
    Returns:
    
    true if the packet is a valid response value packet
  - isSecondaryTerminatorPacket
```
public static boolean isSecondaryTerminatorPacket(SourceRconPacket packet)
```
    Check if the packet is the secondary terminator packet (The secondary terminator packet sent after a request)
    
    Parameters:
    
    packet - SourceRconPacket to check
    
    Returns:
    
    true if the rcon packet is the initial terminator packet (byte terminator value of 0x01)
  - isValidRequestId
```
public static boolean isValidRequestId(int requestId)
```
    Checks if the request id is within the valid range
    
    Parameters:
    
    requestId - An integer representing a request id
    
    Returns:
    
    true if the given request id is within the valid range
  - isValidTerminator
```
public static boolean isValidTerminator(int terminator)
```
    Check if value is valid RCON terminator
    
    Parameters:
    
    terminator - The terminator value
    
    Returns:
    
    true if the value is a valid rcon terminators
  - terminatorPacketEnabled
```
public static boolean terminatorPacketEnabled(io.netty.channel.ChannelHandlerContext ctx)
```
    Convenience method to determine if terminator packets are enabled for the provided channel
    
    Parameters:
    
    ctx - The ChannelHandlerContext
    
    Returns:
    
    true if terminator packets are enabled
  - getPacketTypeName
```
public static String getPacketTypeName(SourceRconPacket packet)
```
    Get the name of the provided SourceRconPacket
    
    Parameters:
    
    packet - The SourceRconPacket to check
    
    Returns:
    
    The name of the SourceRconPacket
  - isAuthRequestPacket
```
public static boolean isAuthRequestPacket(SourceRconPacket packet)
```
    Check if packet is an RCON Auth request packet
    
    Parameters:
    
    packet - The SourceRconPacket to check
    
    Returns:
    
    true if packet is a valid AUTH packet
  - isAuthResponsePacket
```
public static boolean isAuthResponsePacket(SourceRconPacket packet)
```
    Check if packet is an RCON auth response packet
    
    Parameters:
    
    packet - The SourceRconPacket to check
    
    Returns:
    
    true if the packet is a valid auth response packet
  - isCommandResponsePacket
```
public static boolean isCommandResponsePacket(SourceRconPacket packet)
```
    Check if packet is a Command Response Packet
    
    Parameters:
    
    packet - The SourceRconPacket to check
    
    Returns:
    
    true if the packet is a valid command response packet
  - getPacketTypeName
```
public static String getPacketTypeName(int type)
```
    getPacketTypeName.
    
    Parameters:
    
    type - a int
    
    Returns:
    
    a String object
  - createAuthRequest
```
public static SourceRconAuthRequest createAuthRequest(Credentials credentials)
```
    createAuthRequest.
    
    Parameters:
    
    credentials - a Credentials object
    
    Returns:
    
    a SourceRconAuthRequest object
  - createAuthRequest
```
public static SourceRconAuthRequest createAuthRequest(byte[] password)
```
    createAuthRequest.
    
    Parameters:
    
    password - an array of byte objects
    
    Returns:
    
    a SourceRconAuthRequest object
  - createRequestId
```
public static int createRequestId()
```
    A utility method to generate random request ids
    
    Returns:
    
    An random integer ranging from 100000000 to 999999999

Class SourceRcon

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_THREAD_GROUP

RCON_TYPE_REQUEST_AUTH

RCON_TYPE_REQUEST_COMMAND

RCON_TYPE_RESPONSE_AUTH

RCON_TYPE_RESPONSE_VALUE

RCON_TYPE_RESPONSE_VALUE_RUST

RCON_TERMINATOR_RID

INVALIDATED

Constructor Detail

SourceRcon

Method Detail

isInitialTerminatorPacket

isTerminatorPacket

isTerminatorId

isResponseValuePacket

isSecondaryTerminatorPacket

isValidRequestId

isValidTerminator

terminatorPacketEnabled

getPacketTypeName

isAuthRequestPacket

isAuthResponsePacket

isCommandResponsePacket

getPacketTypeName

createAuthRequest

createAuthRequest

createRequestId