TelnetServer.hpp File Reference

#include "telnet/TelnetStats.hpp"
#include <array>
#include <functional>
#include <list>
#include <memory>
#include <string>
#include <thread>
#include <vector>
#include <arpa/inet.h>
#include <netdb.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <unistd.h>

Include dependency graph for TelnetServer.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	TelnetSession
class	TelnetServer

Typedefs
using	Socket = int
using	SP_TelnetSession = std::shared_ptr<TelnetSession>
using	VEC_SP_TelnetSession = std::vector<SP_TelnetSession>
using	FPTR_ConnectedCallback = std::function<void(SP_TelnetSession)>
using	FPTR_NewLineCallback = std::function<bool(SP_TelnetSession, std::string)>
using	FPTR_TabCallback = std::function<std::string(SP_TelnetSession, std::string)>

Functions
void	TelnetPrintAvailableCommands (const SP_TelnetSession &session)
void	TelnetConnectedCallback (const SP_TelnetSession &session)
bool	TelnetMessageCallback (const SP_TelnetSession &session, const std::string &line)
std::string	TelnetTabCallback (const SP_TelnetSession &session, std::string_view line)

Typedef Documentation

FPTR_ConnectedCallback

using FPTR_ConnectedCallback = std::function<void(SP_TelnetSession)>

Definition at line 128 of file TelnetServer.hpp.

FPTR_NewLineCallback

using FPTR_NewLineCallback = std::function<bool(SP_TelnetSession, std::string)>

Definition at line 129 of file TelnetServer.hpp.

FPTR_TabCallback

using FPTR_TabCallback = std::function<std::string(SP_TelnetSession, std::string)>

Definition at line 130 of file TelnetServer.hpp.

Socket

using Socket = int

Definition at line 51 of file TelnetServer.hpp.

SP_TelnetSession

using SP_TelnetSession = std::shared_ptr<TelnetSession>

Definition at line 125 of file TelnetServer.hpp.

VEC_SP_TelnetSession

using VEC_SP_TelnetSession = std::vector<SP_TelnetSession>

Definition at line 126 of file TelnetServer.hpp.

Function Documentation

TelnetConnectedCallback()

void TelnetConnectedCallback

(

const SP_TelnetSession &

session

)

Telnet session connection start callback

Parameters

[in]

session

Handle to session

Definition at line 783 of file TelnetServer.cpp.

{
    session->sendLine("\r\n"
                      "𝑲𝒆𝒆𝒑 𝒚𝒐𝒖𝒓 𝒆𝒚𝒆𝒔 𝒐𝒏 𝒕𝒉𝒆 𝒔𝒕𝒂𝒓𝒔 "
                      "𝒂𝒏𝒅 𝒚𝒐𝒖𝒓 𝒇𝒆𝒆𝒕 𝒐𝒏 𝒕𝒉𝒆 𝒈𝒓𝒐𝒖𝒏𝒅 "
                      "\r\n");
    TelnetPrintAvailableCommands(session);
}

Here is the call graph for this function:

Here is the caller graph for this function:

TelnetMessageCallback()

bool TelnetMessageCallback	(	const SP_TelnetSession &	session,
		const std::string &	line )

Telnet session message received callback

Parameters

[in]	session	Handle to session
[in]	line	Received message

Definition at line 792 of file TelnetServer.cpp.

{
    spdlog::trace("Received message {}", line);
 
    // Send received message for user terminal
    session->sendLine(line);
 
    if (line.empty())
    {
        return true;
    }
 
    // Process received message
    switch (constHasher(line.c_str()))
    {
    case constHasher("Test Message"):
        session->sendLine("OK");
        return true;
    case constHasher("help"):
        TelnetPrintAvailableCommands(session);
        return true;
    case constHasher("disable log"):
        session->sendLine("Default log mode enabled");
#ifdef NDEBUG
        spdlog::set_level(spdlog::level::warn);
#else
        spdlog::set_level(spdlog::level::info);
#endif
        return true;
    case constHasher("disable log all"): // Internal use only
        session->sendLine("Disabling all logs");
        spdlog::set_level(spdlog::level::off);
        return true;
    case constHasher("enable log v"):
        session->sendLine("Info log mode enabled");
        spdlog::set_level(spdlog::level::info);
        return true;
    case constHasher("enable log vv"):
        session->sendLine("Debug log mode enabled");
        spdlog::set_level(spdlog::level::debug);
        return true;
    case constHasher("enable log vvv"):
        session->sendLine("Trace log mode enabled");
        spdlog::set_level(spdlog::level::trace);
        return true;
    case constHasher("ping"):
        session->sendLine("pong");
        return true;
    case constHasher("version"):
        session->sendLine(PROJECT_FULL_VERSION_STRING);
        return true;
    case constHasher("clear"):
        session->sendLine(TELNET_CLEAR_SCREEN);
        return true;
    case constHasher("status"):
        for (const auto &[service, statusFlag] : vCheckFlag)
        {
            session->sendLine(std::format("{:.<{}}{:.>{}} ", service + " ", KEY_WIDTH,
                                          (statusFlag->test() ? " OK" : " Not Active"), VAL_WIDTH));
        }
        return true;
    /* ################################################################################### */
    /* ############################# MAKE MODIFICATIONS HERE ############################# */
    /* ################################################################################### */
 
    /* ################################################################################### */
    /* ################################ END MODIFICATIONS ################################ */
    /* ################################################################################### */
    case constHasher("quit"):
        session->sendLine("Closing connection");
        session->sendLine("Goodbye!");
        session->markTimeout();
        return true;
    default:
        session->sendLine("Unknown command received");
        return false;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

TelnetPrintAvailableCommands()

void TelnetPrintAvailableCommands

(

const SP_TelnetSession &

session

)

Print available commands to the session

Parameters

[in]

session

Handle to session

Definition at line 767 of file TelnetServer.cpp.

{
    // Print available commands
    session->sendLine("");
    session->sendLine("Available commands:");
    session->sendLine("");
    for (const auto &[command, info] : telnetCommands)
    {
        std::array<char, BUFSIZ> buffer{'\0'};
        if (std::format_to_n(buffer.data(), BUFSIZ, "{:<25} : {}", command, info).size > 0)
        {
            session->sendLine(buffer.data());
        }
    }
}

Here is the caller graph for this function:

TelnetTabCallback()

std::string TelnetTabCallback	(	const SP_TelnetSession &	session,
		std::string_view	line )

Telnet session TAB received callback

Parameters

[in]	session	Handle to session
[in]	line	Received message

Returns

std::string Command to complete

Definition at line 871 of file TelnetServer.cpp.

{
    std::string retval;
 
    size_t ctr = 0;
    std::ostringstream sStream;
    for (const auto &[command, info] : telnetCommands)
    {
        if (command.starts_with(line))
        {
            ++ctr;
            retval = command;
            sStream << command << std::setw(KEY_WIDTH);
        }
    }
    // Send suggestions if found any. If there is only one command retval will invoke completion
    if (ctr != 1 && (!sStream.str().empty()))
    {
        session->sendLine(sStream.str());
        retval = "";
    }
 
    return retval;
}

Here is the caller graph for this function: