Telnet++
A C++ library for interacting with Telnet streams
Classes | Typedefs | Functions
telnetpp::options::msdp Namespace Reference

An implementation of the Mud Server Data Protocol. More...

Classes

class  client
 An implementation of the client side of an MSDP Telnet option. More...
 
class  server
 An implementation of the server side of an MSDP Telnet option. More...
 
class  value_type
 A variant that can either be a string, an array of string, or an array of telnetpp::options::msdp::variable. More...
 
struct  variable
 A structure that represents a named value. More...
 

Typedefs

using value_type = boost::variant< std::string, std::vector< std::string >, boost::recursive_wrapper< std::vector< variable >> >
 

Functions

TELNETPP_EXPORT bool operator== (variable const &lhs, variable const &rhs)
 Equality operator.
 
TELNETPP_EXPORT bool operator!= (variable const &lhs, variable const &rhs)
 Inequality operator.
 

Detailed Description

An implementation of the Mud Server Data Protocol.

Overview
MSDP is used to send arbitrary data between server and client.
There is no difference between the server and client protocols for MSDP: both can send and receive arbitrary data packets. However, it is usually the case that the client sends a limited number of packets requesting or subscribing to various standardised data sources. This is, however, entirely application-specific. See the specification page for more details.
Usage
Create a server or client as appropriate. Install it in a session, activate as normal.
Data is transmitted using a telnetpp::options::msdp::variable. These can be sent using your option's send() function, or you can register for changes using the on_receive signal.
See also
http://tintin.sourceforge.net/msdp/