Telnet++  3.1.0.2
A C++ library for interacting with Telnet streams
Public Member Functions | List of all members
telnetpp::client_option Class Reference

A class that represents a Telnet option's client side. That is, the side that receives WILL and WONT negotiations and sends DO and DONT negotiations. More...

#include <client_option.hpp>

Inheritance diagram for telnetpp::client_option:
telnetpp::options::basic_client< telnetpp::options::echo::detail::option > telnetpp::options::basic_client< telnetpp::options::suppress_ga::detail::option > telnetpp::options::basic_client< Option > telnetpp::options::echo::client telnetpp::options::mccp::client telnetpp::options::msdp::client telnetpp::options::naws::client telnetpp::options::new_environ::client telnetpp::options::suppress_ga::client telnetpp::options::terminal_type::client

Public Member Functions

constexpr client_option (telnetpp::session &sess, telnetpp::option_type code) noexcept
 

Detailed Description

A class that represents a Telnet option's client side. That is, the side that receives WILL and WONT negotiations and sends DO and DONT negotiations.

Server vs. Client
Note that the usage of client in this context may disagree with a particular option's RFC specification. The determination of what is a client and what is a server is not rigorously applies throughout the RFCs, so consider this merely an implementation detail of this library.
Usage
client_option provides a general interface to enable the implementation of the client sides of all Telnet options. There are two customization points that must be filled in before an implementation is complete:
  • the derived class must call the constructor, passing in a value that is the Option Code for the feature being implemented.
  • the derived class must implement the handle_subnegotiation function. This is called whenever data specific to the option passes through the Telnet layer.
A final third customization point is the on_state_changed signal, to which a user can connect to have functionality executed when the option changes state.
See also
https://tools.ietf.org/html/std8
The documentation for this class was generated from the following file:
Generated on Mon Mar 25 2024 08:15:22 for Telnet++ by doxygen 1.9.1