Add doc
This commit is contained in:
@@ -6,18 +6,41 @@ using System.Text;
|
||||
|
||||
namespace PlantBox.Shared.Communication
|
||||
{
|
||||
/// <summary>
|
||||
/// Represent a Packet as described in the Wiki > Protocol
|
||||
/// </summary>
|
||||
public class CommandPacket
|
||||
{
|
||||
/// <summary>
|
||||
/// A valid packet command, see the Wiki > Commands
|
||||
/// </summary>
|
||||
public Command Command { get; }
|
||||
/// <summary>
|
||||
/// A valid id
|
||||
/// </summary>
|
||||
public ulong ID { get; }
|
||||
/// <summary>
|
||||
/// Any arguments, see the Wiki page of a command for more infos
|
||||
/// </summary>
|
||||
public string[] Arguments { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Create a <see cref="CommandPacket"/>
|
||||
/// </summary>
|
||||
/// <param name="command"></param>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="arguments"></param>
|
||||
public CommandPacket(Command command, ulong id, string[] arguments)
|
||||
{
|
||||
Command = command;
|
||||
ID = id;
|
||||
Arguments = arguments ?? Array.Empty<string>();
|
||||
}
|
||||
/// <summary>
|
||||
/// Create a <see cref="CommandPacket"/>
|
||||
/// </summary>
|
||||
/// <param name="command"></param>
|
||||
/// <param name="arguments"></param>
|
||||
public CommandPacket(Command command, params string[] arguments)
|
||||
{
|
||||
Command = command;
|
||||
@@ -25,6 +48,10 @@ namespace PlantBox.Shared.Communication
|
||||
Arguments = arguments != null && arguments.Length > 1 ? arguments.Skip(1).ToArray() : Array.Empty<string>();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Convert a <see cref="CommandPacket"/> to a valid text representation of a packet, see Wiki > Protocol
|
||||
/// </summary>
|
||||
/// <returns>A valid packet text representation, ready to be sent</returns>
|
||||
public override string ToString()
|
||||
{
|
||||
return $"{Command.ToString().ToUpperInvariant()}\n{ID}{(Arguments.Length > 0 ? $";{string.Join(";", Arguments)}" : string.Empty)}\n";
|
||||
|
||||
Reference in New Issue
Block a user