summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libtelnetlib.tex
diff options
context:
space:
mode:
authorMartin v. Löwis <martin@v.loewis.de>2001-09-06 08:51:38 (GMT)
committerMartin v. Löwis <martin@v.loewis.de>2001-09-06 08:51:38 (GMT)
commitb0162f9afc115b925475dd76311ce3ea6256257d (patch)
tree7c285df946a8f8b65d45bfb921991a0813a40677 /Doc/lib/libtelnetlib.tex
parent7b0657027f04ac0367908ee0474f6d762366e4bb (diff)
downloadcpython-b0162f9afc115b925475dd76311ce3ea6256257d.zip
cpython-b0162f9afc115b925475dd76311ce3ea6256257d.tar.gz
cpython-b0162f9afc115b925475dd76311ce3ea6256257d.tar.bz2
Patch #416079: fix the debug string output when receiving telnet commands.
added all the telnet options known to arpa/telnet.h added all the options registered with IANA as of today added the possibility for the user to have it's own option negotiation callback
Diffstat (limited to 'Doc/lib/libtelnetlib.tex')
-rw-r--r--Doc/lib/libtelnetlib.tex14
1 files changed, 13 insertions, 1 deletions
diff --git a/Doc/lib/libtelnetlib.tex b/Doc/lib/libtelnetlib.tex
index c772839..91695b3 100644
--- a/Doc/lib/libtelnetlib.tex
+++ b/Doc/lib/libtelnetlib.tex
@@ -9,7 +9,12 @@
The \module{telnetlib} module provides a \class{Telnet} class that
implements the Telnet protocol. See \rfc{854} for details about the
-protocol.
+protocol. In addition, it provides symbolic constants for the protocol
+characters (IAC/DONT/DO/WONT/WILL), and for the telnet options. The
+symbolic names of the telnet options follow the definitions in
+\code{arpa/telnet.h}, with the leading \code{TELOPT_} removed. For
+symbolic names of options which are traditionally not included in
+\code{arpa/telnet.h}, see the module source itself.
\begin{classdesc}{Telnet}{\optional{host\optional{, port}}}
@@ -158,6 +163,13 @@ or if more than one expression can match the same input, the
results are indeterministic, and may depend on the I/O timing.
\end{methoddesc}
+\begin{methoddesc}{set_option_negotiation_callback}{callback}
+Each time a telnet option is read on the input flow, this
+\var{callback} (if set) is called with the following parameters :
+callback(telnet socket, command (DO/DONT/WILL/WONT), option). No other
+action is done afterwards by telnetlib.
+\end{methoddesc}
+
\subsection{Telnet Example \label{telnet-example}}
\sectionauthor{Peter Funk}{pf@artcom-gmbh.de}