com.ibasco.agql.protocols.valve.source.query.rcon.packets

Class SourceRconPacketFactory

java.lang.Object

com.ibasco.agql.protocols.valve.source.query.rcon.packets.SourceRconPacketFactory

public final class SourceRconPacketFactory
extends Object

A factory class for creating SourceRconPacket instances

Author:

Rafael Luis Ibasco

Method Summary

Modifier and Type	Method and Description
static SourceRconPacket	createAuth(int id, byte[] password) Create a new Authentication Request Packet
static SourceRconPacket	createAuthResponse(int id) Create an authentication response packet
static SourceRconPacket	createCommand(int id, String command) Create a command request packet
static SourceRconPacket	createPacket(int id, int type, io.netty.buffer.ByteBuf payload) createPacket.
static SourceRconPacket	createPacket(int size, int id, int type, int terminator, io.netty.buffer.ByteBuf payload) createPacket.
static SourceRconPacket	createResponseValue(int id, io.netty.buffer.ByteBuf payload) Create a response value packet
static SourceRconPacket	createResponseValue(int id, String response) Create a response value packet
static SourceRconPacket	createTerminator() Create a new terminator packet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createAuth

public static SourceRconPacket createAuth(int id,
                                          byte[] password)

Create a new Authentication Request Packet

Parameters:

id - The request id to be associated with this request

password - The rcon password to use to authenticate with the server

Returns:

A SourceRconPacket

createPacket

public static SourceRconPacket createPacket(int id,
                                            int type,
                                            io.netty.buffer.ByteBuf payload)

createPacket.

Parameters:

id - a int

type - a int

payload - a ByteBuf object

Returns:

a SourceRconPacket object

createPacket

public static SourceRconPacket createPacket(int size,
                                            int id,
                                            int type,
                                            int terminator,
                                            io.netty.buffer.ByteBuf payload)

createPacket.

Parameters:

size - a int

id - a int

type - a int

terminator - a int

payload - a ByteBuf object

Returns:

a SourceRconPacket object

createAuthResponse

public static SourceRconPacket createAuthResponse(int id)

Create an authentication response packet

Parameters:

id - A positive integer indicating a successful authentication or -1 if authentication failed

Returns:

An authentication response packet wrapped in SourceRconPacket

createCommand

public static SourceRconPacket createCommand(int id,
                                             String command)

Create a command request packet

Parameters:

id - A unique positive integer

command - The command to be sent to the server

Returns:

A command request packet wrapped in SourceRconPacket

createTerminator

public static SourceRconPacket createTerminator()

Create a new terminator packet. A terminator packet is a special type of response value packet which sent after every command issued to the server.

Returns:

A special response value packet with an id of -1 wrapped in SourceRconPacket

createResponseValue

public static SourceRconPacket createResponseValue(int id,
                                                   String response)

Create a response value packet

Parameters:

id - A positive or negative value

response - The message payload of the response in the form of a String

Returns:

A SourceRconPacket

createResponseValue

public static SourceRconPacket createResponseValue(int id,
                                                   io.netty.buffer.ByteBuf payload)

Create a response value packet

Parameters:

id - A positive or negative value

payload - The message payload of the response

Returns:

A SourceRconPacket