ZayniFramework.Middle.TelnetService 2.2.3

Middle.TelnetService example.

The Middle.TelnetService and Common module provide the API of ICommand, ConsoleCommand and RemoteCommand for your application. You can use it to build a telnet service to receive the remote telnet command from any telent client very easily!

Add namespace using.

using ZayniFramework.Common;
using ZayniFramework.Middle.TelnetService;

Write your ConsoleCommand class and extends the ConsoleCommand base class.

public sealed class YourConsoleCommand : ConsoleCommand
{
    /// <summary>Execute the command.
    /// </summary>
    public override void ExecuteCommand() 
    {
        // Implement your code here...
        Result.Success = true;
    } 
}

Write your telnet RemoteCommand class and extends the RemoteCommand base class.

public class YourRemoteCommand : RemoteCommand
{
    /// <summary>Execute the command.
    /// </summary>
    public override void ExecuteCommand()
    {
        // Implement your code here...
        Result.Success = r.Success;
    }
}

Then, you have to register your ICommand object to the CommandContainer. Like this,

private static CommandContainer RegisterCommands()
{
    var commandContainer = new CommandContainer();
    commandContainer.RegisterCommand<YourConsoleCommand>( "the command name 1", commandText => 0 == string.Compare( commandText, "some command line", true ) );
    commandContainer.RegisterCommand<YourRemoteCommand>( "the command name 12", commandText => 0 == string.Compare( commandText, "some command line", true ) );
    commandContainer.RegisterCommand<ClearConsoleCommand>( "cls", commandText => 0 == string.Compare( commandText, "cls", true ) );
    commandContainer.RegisterUnknowCommand<UnknowRemoteCommand>();
    return commandContainer;
}

Start to process to receive the console command in your application. And create a TelnetServer, then start the telnet service.

private static void ProcessConsoleCommand( CommandContainer container )
{
    while ( true )
    {
        string commandText = null;

        try
        {
            commandText = Console.ReadLine();

            if ( commandText.IsNullOrEmpty() )
            {
                continue;
            }

            var command = container.Get<ConsoleCommand>( commandText );

            if ( command.IsNull() )
            {
                continue;
            }

            command.Command = commandText;
            command.Execute();    
        }
        catch ( Exception ex )
        {
            Logger.WriteExceptionLog( nameof ( Program ), ex, $"Process console command occur exception. Console command: {commandText}. {Environment.NewLine}{ex.ToString()}" );
            continue;
        }
    }
}

private static void StartTelnetService( CommandContainer commandContainer ) 
{
    if ( !ConfigManagement.AppSettings.ContainsKey( "TelnetServerPort" ) )
    {
        return;
    }

    var strPort = ConfigManagement.AppSettings[ "TelnetServerPort" ];

    if ( strPort.IsNullOrEmpty() || !int.TryParse( strPort, out int port ) || port <= 0 )
    {
        return;
    }

    var password      = ConfigManagement.AppSettings.ContainsKey( "TelnetServerPassword" ) ? ConfigManagement.AppSettings[ "TelnetServerPassword" ] : null;
    var telnetService = new TelnetServer( port, password );
    telnetService.StartService( ( reader, writer, client ) => ProcessTelnetCommand( reader, writer, client, commandContainer ) );
    Console.WriteLine( $"Start telnet server success. Listen tcp port on {strPort}." );
}

private static void ProcessTelnetCommand( StreamReader reader, StreamWriter writer, TcpClient tcpClient, CommandContainer container ) 
{
    if ( reader.IsNull() || writer.IsNull() || !tcpClient.Connected )
    {
        return;
    }

    if ( !reader.BaseStream.CanRead || !writer.BaseStream.CanWrite )
    {
        return;
    }

    while ( true ) 
    {
        try
        {
            if ( !reader.BaseStream.CanRead || !writer.BaseStream.CanWrite )
            {
                break;
            }

            var commandText = reader.ReadLine();
            var command     = container.Get<RemoteCommand>( commandText );

            if ( command.IsNull() )
            {
                continue;
            }

            command.Command      = commandText;
            command.StreamReader = reader;
            command.StreamWriter = writer;
            command.TelnetClient = tcpClient;    
            command.Execute();
        }
        catch ( Exception ex )
        {
            Logger.WriteExceptionLog( nameof ( Program ), ex, $"Process telnet command occur exception. {Environment.NewLine}{ex.ToString()}" );
            continue;
        }
    }
}

Finally, you can start the console command and telnet remote command service to receive the commands. Like this.

var commandContainer = RegisterCommands();
StartTelnetService( commandContainer );
ProcessConsoleCommand( commandContainer );

More detail and sample. You can go to the Test/ServiceHostTest/ServiceHost.Client.App directory.