telnetpp::options::new_environ::client Class Reference

An implementation of the client side of the Telnet New-Environ option. More...

#include <client.hpp>

Inheritance diagram for telnetpp::options::new_environ::client:

Public Member Functions
	client ()
	CONSTRUCTOR.
std::vector< token >	request_variables (std::vector< request > const &requests)
	Requests that a particular set of environment variables be transmitted by the client. More...
Public Member Functions inherited from telnetpp::client_option
telnetpp::u8	option () const
	Returns the option code.
void	set_activatable ()
	Flags the option as remotely activatable. More...
std::vector< telnetpp::token >	activate ()
	Activates the option; sends a DO negotiation.
std::vector< telnetpp::token >	deactivate ()
	Deactivates the option; sends a DONT negotiation.
bool	is_active () const
	Returns true iff the option is active.
std::vector< telnetpp::token >	negotiate (telnetpp::u8 request)
	Makes a request of the option and returns the response from that request. More...
std::vector< telnetpp::token >	subnegotiate (telnetpp::u8stream const &content)
	Send a subnegotiation to the option and returns the response from that subnegotiation. More...

Public Attributes
boost::signals2::signal< std::vector< token >response const &res), telnetpp::token_combiner >	on_variable_changed
	Signal called whenever an environment variable is updated. More...
Public Attributes inherited from telnetpp::client_option
boost::signals2::signal< std::vector< telnetpp::token >state new_state), token_combiner >	on_state_changed
	A signal that you can connect to in order to detect changes in the state of the option. More...

Additional Inherited Members
Public Types inherited from telnetpp::client_option
enum	state { inactive, activating, active, deactivating }
	An enumeration of the different states in which this option can be. More...
Protected Member Functions inherited from telnetpp::client_option
	client_option (telnetpp::u8 option)
	Constructor. More...

Detailed Description

An implementation of the client side of the Telnet New-Environ option.

Member Function Documentation

std::vector< token > telnetpp::options::new_environ::client::request_variables

(

std::vector< request > const &

requests

)

Requests that a particular set of environment variables be transmitted by the client.

Member Data Documentation

boost::signals2::signal< std::vector<token>response const &res), telnetpp::token_combiner > telnetpp::options::new_environ::client::on_variable_changed

Signal called whenever an environment variable is updated.

Parameters

type	the type of the variable; either var or uservar.
name	the name of the variable.
value	the value of the variable, including the possibility of it being undefined.

---

The documentation for this class was generated from the following files:

• include/telnetpp/options/new_environ/client.hpp
• src/options/new_environ/client.cpp