The telnetlib Reference Manual
Table of Contents
The telnetlib Reference Manual
This is the telnetlib Reference Manual, version 0.1,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 15:13:46 2020 GMT+0.
1 Introduction
;; -*- MODE: LISP -*-
;;
;; Brian Jiang (brianjcj AT gmail.com)
;; 2007-11
;;
;; TelnetLib
;; =========
;; In our ordinary work, we often write some automatically scripts
;; which login in the server to run some commands and performce some
;; actions based on the result of the commands. In this case, a telnet
;; client library will be very helpful. Such a library is very handy
;; in Perl, Python and Ruby. But I googled it a lot and failed to find
;; one in Common Lisp. So I decided to port the Telnetlib from Python
;; to Common Lisp. Why port from Python? Because I am more familiar
;; with Python and have use its TelnetLib before :-)
;;
;; The functionality of this library is almost the same as Python's
;; one. But the interface is a little different.
;; Supported Lisp implementations
;; ==============================
;; - SBCL
;; - LispWorks
;; - Allegro CL
;; - CLISP
;;
;; TelnetLib also supports other Lisp implementations (require USOCKET
;; and FLEXI-STREAMS) . But I have never done any testing for them.
;; Testing:
;; --------
;; TelnetLib has been tested in following environment:
;; - sbcl-1.0.11-x86-linux
;; - LispWorks in Windows XP
;; - Allegro CL in Windows XP
;; - CLISP 2.43 in Linux
;; - CLISP 2.41 in Windows XP
;;
;; But it failed in sbcl-1.0.9 in Windows XP. Error occurs
;; when writing the socket stream.
;; Library Dependency
;; ==================
;; For SBCL, LispWorks, Allegro CL and CLISP, it only depends on
;; CL-PPCRE.
;; For other Lisp implementations, USOCKET and FLEXI-STREAMS (to
;; set the external-format) are also required.
;; Known Problem
;; =============
;; Don't work well when telent localhost. It seems it is due to the process/thread
;; schedule mechanism. Will try to fix it in the future.
;; How to use it
;; =============
;; Export functions/macros:
;; ------------------------
(defun open-telnet-session (host &optional port)...)
(defun close-telnet-session (tn)....)
(defmacro with-telnet-session ((tn host &optional port) &body body)....)
(defun set-telnet-session-option (tn
&key (remove-return-char nil r-r-c-p)
(debug-on nil debug-on-p)
(char-callback nil char-callback-p)
(option-callback nil option-callback-p)
(sb-option-callback nil sb-option-callback-p))...)
(defun peek-available-data (tn &optional block-read)....)
(defun read-available-data (tn &optional block-read)....
(defun read-until (tn str &key (timeout 600) case-insensitive-mode)....)
(defun read-until-2 (tn strings &key (timeout 600) case-insensitive-mode)....)
(defun read-until-2-ind (tn strings &key (timeout 600) case-insensitive-mode)....)
(defun expect (tn regexp &optional (timeout 600))....)
(defun format-tn (tn control-string &rest format-arguments)....)
(defun write-ln (tn str)....)
(defun write-ln-crlr (tn str)....)
;; Example:
;; --------
(defun example-1 ()
(with-telnet-session (tn "202.38.33.94")
(set-telnet-session-option tn :remove-return-char t)
(read-until tn "ogin:")
(write-ln tn "brianjcj")
(read-until tn "assword:")
(write-ln tn "abcdefg12")
(read-until tn ">")
(format-tn tn "~A~%" "pwd") ;; stupid demo :-)
(read-until tn ">")
(write-ln tn "cmd1")
(read-until-2 tn (list "Done." "Error" "Pending.")
:case-insensitive-mode t)
(read-until tn ">")
(write-ln tn "cmd2")
(expect tn
(cl-ppcre:create-scanner
"OK\|NO"
:case-insensitive-mode t))
(read-until tn ">")
(write-ln tn "cmd3")
(expect tn "Done\|Try later.")
(read-until tn ">")
(write-ln tn-vmap "unload testci")
(case (read-until-2-ind tn (list "Please confirm (" "has not been loaded yet"))
((0)
(read-until tn *prompt*)
(sleep *rest-time*)
(write-ln tn "Y")
(read-until tn *prompt*))
((1)
(read-until tn-vmap *prompt*)))
(write-ln tn "exit")
(loop until (eof tn) do
(read-available-data tn t))
))
(defun example-2 ()
(with-telnet-session (tn "202.38.33.94")
(set-telnet-session-option tn :char-callback nil)
(princ (read-until tn "ogin:"))
(write-ln tn "brianjcj")
(princ (read-until tn "PassWord:"
:case-insensitive-mode t))
(write-ln tn "zaq12WSX")
(princ (read-until tn ">"))
(write-ln tn "ls")
(princ (read-until tn ">"))
(write-ln tn "cmd1")
(princ (expect tn "Done\|Error"))
(princ (read-until tn ">"))
(write-ln tn "cmd2")
(princ (read-until-2
tn
(list "OK." "Try again" "Later.")
:timeout 10))
(princ (read-until tn ">"))
(write-ln tn "cmd3")
(princ (read-until-2
tn (list "Right" "Wrong")
:timeout 10 :case-insensitive-mode t))
(princ (read-until tn ">"))
(write-ln tn "cmd4")
(princ (expect
tn
(cl-ppcre:create-scanner
"Right\|Wrong"
:case-insensitive-mode t)))
(princ (read-until tn ">"))
(write-ln tn "exit")
(loop until (eof tn) do
(princ (read-available-data tn t)))
))
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 telnetlib
- Version
0.1
- Dependencies
-
- Source
telnetlib.asd (file)
- Components
-
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 telnetlib.asd
- Location
telnetlib.asd
- Systems
telnetlib (system)
- Packages
telnetlib-asd
3.1.2 telnetlib/packages.lisp
- Parent
telnetlib (system)
- Location
packages.lisp
- Packages
telnetlib
3.1.3 telnetlib/telnetconst.lisp
- Dependency
packages.lisp (file)
- Parent
telnetlib (system)
- Location
telnetconst.lisp
- Internal Definitions
-
3.1.4 telnetlib/telnetlib.lisp
- Dependency
telnetconst.lisp (file)
- Parent
telnetlib (system)
- Location
telnetlib.lisp
- Exported Definitions
-
- Internal Definitions
-
4 Packages
Packages are listed by definition order.
4.1 telnetlib-asd
- Source
telnetlib.asd
- Use List
- asdf/interface
- common-lisp
4.2 telnetlib
- Source
packages.lisp (file)
- Use List
- sb-bsd-sockets
- common-lisp
- Exported Definitions
-
- Internal Definitions
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Exported definitions
5.1.1 Macros
- Macro: with-telnet-session (TN HOST &optional PORT) &body BODY
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
5.1.2 Functions
- Function: close-telnet-session TN
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: eof-tn TN
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: expect TN REGEXP &optional TIMEOUT
-
Read until one from a list of a regular expressions matches or until timeout.
When no match is found, return nil with a :eof or :timeout, and
the all the received data will still stay in the cookedq vector.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: format-tn TN CONTROL-STRING &rest FORMAT-ARGUMENTS
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: open-telnet-session HOST &optional PORT
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: peek-available-data TN &optional BLOCK-READ
-
Just take a look at the available data.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: peek-sbdata TN
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: read-available-data TN &optional BLOCK-READ
-
Read all the available data. If block-read is not nil, block
the reading until at least a char arrives at the socket stream.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: read-until TN STR &key TIMEOUT CASE-INSENSITIVE-MODE
-
Read until a given string is encountered or until timeout.
When no match is found, return nil with a :eof or :timeout, and
the all the received data will still stay in the cookedq vector.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: read-until-2 TN STRINGS &key TIMEOUT CASE-INSENSITIVE-MODE
-
Read until one from a list of strings is encountered or until timeout.
When no match is found, return nil with a :eof or :timeout, and
the all the received data will still stay in the cookedq vector.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: read-until-2-ind TN STRINGS &key TIMEOUT CASE-INSENSITIVE-MODE
-
Sometimes, we more care about which string is matched.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: set-telnet-session-option TN &key REMOVE-RETURN-CHAR DEBUG-ON CHAR-CALLBACK OPTION-CALLBACK SB-OPTION-CALLBACK
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: write-ln TN STR
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: write-ln-crlr TN STR
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
5.1.3 Conditions
- Condition: telnet-eof ()
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Direct superclasses
simple-condition (condition)
- Condition: telnet-read-timeout ()
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Direct superclasses
simple-condition (condition)
5.2 Internal definitions
5.2.1 Constants
- Constant: +ao+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +authentication+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +ayt+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +binary+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +bm+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +brk+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +charset+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +com_port_option+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +det+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +dm+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +do+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +dont+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +ec+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +echo+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +el+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +encrypt+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +eor+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +exopl+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +forward_x+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +ga+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +iac+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +ip+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +kermit+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +lflow+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +linemode+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +logout+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +nams+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naocrd+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naoffd+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naohtd+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naohts+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naol+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naolfd+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naop+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naovtd+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naovts+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +naws+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +new_environ+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +noopt+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +nop+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +old_environ+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +outmrk+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +pragma_heartbeat+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +pragma_logon+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +rcp+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +rcte+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +rsp+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +sb+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +se+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +send_url+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +sga+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +sndloc+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +sspi_logon+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +status+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +supdup+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +supdupoutput+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +suppress_local_echo+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +telnet-port+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +thenull+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +tls+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +tm+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +tn3270e+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +tspeed+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +ttyloc+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +ttype+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +tuid+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +vt3270regime+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +will+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +wont+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +x3pad+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +xascii+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +xauth+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
- Constant: +xdisploc+
-
- Package
telnetlib
- Source
telnetconst.lisp (file)
5.2.2 Special variables
- Special Variable: *tn-internal-debug*
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
5.2.3 Functions
- Function: char-equal-case-insensitive% C1 C2
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: default-option-callback% S CMD CODE
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: default-sb-option-callback% S SBDATA
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: process-sock-stream% TN &optional BLOCK-READ
-
Internal procedure to read all the available data from the socket stream
to cookedq.
Return :no-data when no data filled the cookeq.
Return :old-data when no new data read from socket stream but cookeq has old data.
Return :new-data when new data are read from socket stream to cookeq.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: read-cookedq% TN END-POS
-
Read the cookedq vector from 0 to end-pos.
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: send-sub-terminal-type-is% S &optional TTYPE
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Function: wait-until-readable% STREAM &optional TIMEOUT DEBUG-ON
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
5.2.4 Generic functions
- Generic Function: char-callback OBJECT
-
- Generic Function: (setf char-callback) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: char-callback (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf char-callback) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: cookedq OBJECT
-
- Generic Function: (setf cookedq) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: cookedq (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf cookedq) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: debug-on OBJECT
-
- Generic Function: (setf debug-on) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: debug-on (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf debug-on) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: eof OBJECT
-
- Generic Function: (setf eof) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: eof (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf eof) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: host OBJECT
-
- Generic Function: (setf host) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: host (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf host) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: iacseq OBJECT
-
- Generic Function: (setf iacseq) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: iacseq (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf iacseq) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: option-callback OBJECT
-
- Generic Function: (setf option-callback) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: option-callback (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf option-callback) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: port OBJECT
-
- Generic Function: (setf port) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: port (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf port) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: remove-return-char OBJECT
-
- Generic Function: (setf remove-return-char) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: remove-return-char (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf remove-return-char) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: sb OBJECT
-
- Generic Function: (setf sb) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: sb (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf sb) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: sb-option-callback OBJECT
-
- Generic Function: (setf sb-option-callback) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: sb-option-callback (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf sb-option-callback) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: sbdataq OBJECT
-
- Generic Function: (setf sbdataq) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: sbdataq (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf sbdataq) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
- Generic Function: sock-stream OBJECT
-
- Generic Function: (setf sock-stream) NEW-VALUE OBJECT
-
- Package
telnetlib
- Methods
- Method: sock-stream (TELNET telnet)
-
automatically generated reader method
- Source
telnetlib.lisp (file)
- Method: (setf sock-stream) NEW-VALUE (TELNET telnet)
-
automatically generated writer method
- Source
telnetlib.lisp (file)
5.2.5 Classes
- Class: telnet ()
-
- Package
telnetlib
- Source
telnetlib.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: host
-
- Initargs
:host
- Readers
host (generic function)
- Writers
(setf host) (generic function)
- Slot: port
-
- Initargs
:port
- Initform
telnetlib::+telnet-port+
- Readers
port (generic function)
- Writers
(setf port) (generic function)
- Slot: sock-stream
-
- Initargs
:sock-stream
- Readers
sock-stream (generic function)
- Writers
(setf sock-stream) (generic function)
- Slot: cookedq
-
- Initform
(make-array 4096 :element-type (quote character) :fill-pointer 0 :adjustable t)
- Readers
cookedq (generic function)
- Writers
(setf cookedq) (generic function)
- Slot: eof
-
- Readers
eof (generic function)
- Writers
(setf eof) (generic function)
- Slot: iacseq
-
- Initform
(make-array 3 :element-type (quote character) :fill-pointer 0)
- Readers
iacseq (generic function)
- Writers
(setf iacseq) (generic function)
- Slot: sb
-
- Initform
0
- Readers
sb (generic function)
- Writers
(setf sb) (generic function)
- Slot: sbdataq
-
- Initform
(make-array 64 :element-type (quote character) :fill-pointer 0 :adjustable t)
- Readers
sbdataq (generic function)
- Writers
(setf sbdataq) (generic function)
- Slot: option-callback
-
- Initargs
:option-callback
- Readers
option-callback (generic function)
- Writers
(setf option-callback) (generic function)
- Slot: sb-option-callback
-
- Initargs
:sb-option-callback
- Readers
sb-option-callback (generic function)
- Writers
(setf sb-option-callback) (generic function)
- Slot: char-callback
-
- Initargs
:char-callback
- Initform
(function (lambda (telnetlib::c telnetlib::s) (declare (ignore telnetlib::s)) (princ telnetlib::c)))
- Readers
char-callback (generic function)
- Writers
(setf char-callback) (generic function)
- Slot: remove-return-char
-
- Initargs
:remove-return-char
- Initform
t
- Readers
remove-return-char (generic function)
- Writers
(setf remove-return-char) (generic function)
- Slot: debug-on
-
- Readers
debug-on (generic function)
- Writers
(setf debug-on) (generic function)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
F | | |
| File, Lisp, telnetlib.asd: | | The telnetlib․asd file |
| File, Lisp, telnetlib/packages.lisp: | | The telnetlib/packages․lisp file |
| File, Lisp, telnetlib/telnetconst.lisp: | | The telnetlib/telnetconst․lisp file |
| File, Lisp, telnetlib/telnetlib.lisp: | | The telnetlib/telnetlib․lisp file |
|
L | | |
| Lisp File, telnetlib.asd: | | The telnetlib․asd file |
| Lisp File, telnetlib/packages.lisp: | | The telnetlib/packages․lisp file |
| Lisp File, telnetlib/telnetconst.lisp: | | The telnetlib/telnetconst․lisp file |
| Lisp File, telnetlib/telnetlib.lisp: | | The telnetlib/telnetlib․lisp file |
|
T | | |
| telnetlib.asd: | | The telnetlib․asd file |
| telnetlib/packages.lisp: | | The telnetlib/packages․lisp file |
| telnetlib/telnetconst.lisp: | | The telnetlib/telnetconst․lisp file |
| telnetlib/telnetlib.lisp: | | The telnetlib/telnetlib․lisp file |
|
A.2 Functions
| Index Entry | | Section |
|
( | | |
| (setf char-callback) : | | Internal generic functions |
| (setf char-callback) : | | Internal generic functions |
| (setf cookedq) : | | Internal generic functions |
| (setf cookedq) : | | Internal generic functions |
| (setf debug-on) : | | Internal generic functions |
| (setf debug-on) : | | Internal generic functions |
| (setf eof) : | | Internal generic functions |
| (setf eof) : | | Internal generic functions |
| (setf host) : | | Internal generic functions |
| (setf host) : | | Internal generic functions |
| (setf iacseq) : | | Internal generic functions |
| (setf iacseq) : | | Internal generic functions |
| (setf option-callback) : | | Internal generic functions |
| (setf option-callback) : | | Internal generic functions |
| (setf port) : | | Internal generic functions |
| (setf port) : | | Internal generic functions |
| (setf remove-return-char) : | | Internal generic functions |
| (setf remove-return-char) : | | Internal generic functions |
| (setf sb) : | | Internal generic functions |
| (setf sb) : | | Internal generic functions |
| (setf sb-option-callback) : | | Internal generic functions |
| (setf sb-option-callback) : | | Internal generic functions |
| (setf sbdataq) : | | Internal generic functions |
| (setf sbdataq) : | | Internal generic functions |
| (setf sock-stream) : | | Internal generic functions |
| (setf sock-stream) : | | Internal generic functions |
|
C | | |
| char-callback : | | Internal generic functions |
| char-callback : | | Internal generic functions |
| char-equal-case-insensitive% : | | Internal functions |
| close-telnet-session : | | Exported functions |
| cookedq : | | Internal generic functions |
| cookedq : | | Internal generic functions |
|
D | | |
| debug-on : | | Internal generic functions |
| debug-on : | | Internal generic functions |
| default-option-callback% : | | Internal functions |
| default-sb-option-callback% : | | Internal functions |
|
E | | |
| eof : | | Internal generic functions |
| eof : | | Internal generic functions |
| eof-tn : | | Exported functions |
| expect : | | Exported functions |
|
F | | |
| format-tn : | | Exported functions |
| Function, char-equal-case-insensitive% : | | Internal functions |
| Function, close-telnet-session : | | Exported functions |
| Function, default-option-callback% : | | Internal functions |
| Function, default-sb-option-callback% : | | Internal functions |
| Function, eof-tn : | | Exported functions |
| Function, expect : | | Exported functions |
| Function, format-tn : | | Exported functions |
| Function, open-telnet-session : | | Exported functions |
| Function, peek-available-data : | | Exported functions |
| Function, peek-sbdata : | | Exported functions |
| Function, process-sock-stream% : | | Internal functions |
| Function, read-available-data : | | Exported functions |
| Function, read-cookedq% : | | Internal functions |
| Function, read-until : | | Exported functions |
| Function, read-until-2 : | | Exported functions |
| Function, read-until-2-ind : | | Exported functions |
| Function, send-sub-terminal-type-is% : | | Internal functions |
| Function, set-telnet-session-option : | | Exported functions |
| Function, wait-until-readable% : | | Internal functions |
| Function, write-ln : | | Exported functions |
| Function, write-ln-crlr : | | Exported functions |
|
G | | |
| Generic Function, (setf char-callback) : | | Internal generic functions |
| Generic Function, (setf cookedq) : | | Internal generic functions |
| Generic Function, (setf debug-on) : | | Internal generic functions |
| Generic Function, (setf eof) : | | Internal generic functions |
| Generic Function, (setf host) : | | Internal generic functions |
| Generic Function, (setf iacseq) : | | Internal generic functions |
| Generic Function, (setf option-callback) : | | Internal generic functions |
| Generic Function, (setf port) : | | Internal generic functions |
| Generic Function, (setf remove-return-char) : | | Internal generic functions |
| Generic Function, (setf sb) : | | Internal generic functions |
| Generic Function, (setf sb-option-callback) : | | Internal generic functions |
| Generic Function, (setf sbdataq) : | | Internal generic functions |
| Generic Function, (setf sock-stream) : | | Internal generic functions |
| Generic Function, char-callback : | | Internal generic functions |
| Generic Function, cookedq : | | Internal generic functions |
| Generic Function, debug-on : | | Internal generic functions |
| Generic Function, eof : | | Internal generic functions |
| Generic Function, host : | | Internal generic functions |
| Generic Function, iacseq : | | Internal generic functions |
| Generic Function, option-callback : | | Internal generic functions |
| Generic Function, port : | | Internal generic functions |
| Generic Function, remove-return-char : | | Internal generic functions |
| Generic Function, sb : | | Internal generic functions |
| Generic Function, sb-option-callback : | | Internal generic functions |
| Generic Function, sbdataq : | | Internal generic functions |
| Generic Function, sock-stream : | | Internal generic functions |
|
H | | |
| host : | | Internal generic functions |
| host : | | Internal generic functions |
|
I | | |
| iacseq : | | Internal generic functions |
| iacseq : | | Internal generic functions |
|
M | | |
| Macro, with-telnet-session : | | Exported macros |
| Method, (setf char-callback) : | | Internal generic functions |
| Method, (setf cookedq) : | | Internal generic functions |
| Method, (setf debug-on) : | | Internal generic functions |
| Method, (setf eof) : | | Internal generic functions |
| Method, (setf host) : | | Internal generic functions |
| Method, (setf iacseq) : | | Internal generic functions |
| Method, (setf option-callback) : | | Internal generic functions |
| Method, (setf port) : | | Internal generic functions |
| Method, (setf remove-return-char) : | | Internal generic functions |
| Method, (setf sb) : | | Internal generic functions |
| Method, (setf sb-option-callback) : | | Internal generic functions |
| Method, (setf sbdataq) : | | Internal generic functions |
| Method, (setf sock-stream) : | | Internal generic functions |
| Method, char-callback : | | Internal generic functions |
| Method, cookedq : | | Internal generic functions |
| Method, debug-on : | | Internal generic functions |
| Method, eof : | | Internal generic functions |
| Method, host : | | Internal generic functions |
| Method, iacseq : | | Internal generic functions |
| Method, option-callback : | | Internal generic functions |
| Method, port : | | Internal generic functions |
| Method, remove-return-char : | | Internal generic functions |
| Method, sb : | | Internal generic functions |
| Method, sb-option-callback : | | Internal generic functions |
| Method, sbdataq : | | Internal generic functions |
| Method, sock-stream : | | Internal generic functions |
|
O | | |
| open-telnet-session : | | Exported functions |
| option-callback : | | Internal generic functions |
| option-callback : | | Internal generic functions |
|
P | | |
| peek-available-data : | | Exported functions |
| peek-sbdata : | | Exported functions |
| port : | | Internal generic functions |
| port : | | Internal generic functions |
| process-sock-stream% : | | Internal functions |
|
R | | |
| read-available-data : | | Exported functions |
| read-cookedq% : | | Internal functions |
| read-until : | | Exported functions |
| read-until-2 : | | Exported functions |
| read-until-2-ind : | | Exported functions |
| remove-return-char : | | Internal generic functions |
| remove-return-char : | | Internal generic functions |
|
S | | |
| sb : | | Internal generic functions |
| sb : | | Internal generic functions |
| sb-option-callback : | | Internal generic functions |
| sb-option-callback : | | Internal generic functions |
| sbdataq : | | Internal generic functions |
| sbdataq : | | Internal generic functions |
| send-sub-terminal-type-is% : | | Internal functions |
| set-telnet-session-option : | | Exported functions |
| sock-stream : | | Internal generic functions |
| sock-stream : | | Internal generic functions |
|
W | | |
| wait-until-readable% : | | Internal functions |
| with-telnet-session : | | Exported macros |
| write-ln : | | Exported functions |
| write-ln-crlr : | | Exported functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *tn-internal-debug* : | | Internal special variables |
|
+ | | |
| +ao+ : | | Internal constants |
| +authentication+ : | | Internal constants |
| +ayt+ : | | Internal constants |
| +binary+ : | | Internal constants |
| +bm+ : | | Internal constants |
| +brk+ : | | Internal constants |
| +charset+ : | | Internal constants |
| +com_port_option+ : | | Internal constants |
| +det+ : | | Internal constants |
| +dm+ : | | Internal constants |
| +do+ : | | Internal constants |
| +dont+ : | | Internal constants |
| +ec+ : | | Internal constants |
| +echo+ : | | Internal constants |
| +el+ : | | Internal constants |
| +encrypt+ : | | Internal constants |
| +eor+ : | | Internal constants |
| +exopl+ : | | Internal constants |
| +forward_x+ : | | Internal constants |
| +ga+ : | | Internal constants |
| +iac+ : | | Internal constants |
| +ip+ : | | Internal constants |
| +kermit+ : | | Internal constants |
| +lflow+ : | | Internal constants |
| +linemode+ : | | Internal constants |
| +logout+ : | | Internal constants |
| +nams+ : | | Internal constants |
| +naocrd+ : | | Internal constants |
| +naoffd+ : | | Internal constants |
| +naohtd+ : | | Internal constants |
| +naohts+ : | | Internal constants |
| +naol+ : | | Internal constants |
| +naolfd+ : | | Internal constants |
| +naop+ : | | Internal constants |
| +naovtd+ : | | Internal constants |
| +naovts+ : | | Internal constants |
| +naws+ : | | Internal constants |
| +new_environ+ : | | Internal constants |
| +noopt+ : | | Internal constants |
| +nop+ : | | Internal constants |
| +old_environ+ : | | Internal constants |
| +outmrk+ : | | Internal constants |
| +pragma_heartbeat+ : | | Internal constants |
| +pragma_logon+ : | | Internal constants |
| +rcp+ : | | Internal constants |
| +rcte+ : | | Internal constants |
| +rsp+ : | | Internal constants |
| +sb+ : | | Internal constants |
| +se+ : | | Internal constants |
| +send_url+ : | | Internal constants |
| +sga+ : | | Internal constants |
| +sndloc+ : | | Internal constants |
| +sspi_logon+ : | | Internal constants |
| +status+ : | | Internal constants |
| +supdup+ : | | Internal constants |
| +supdupoutput+ : | | Internal constants |
| +suppress_local_echo+ : | | Internal constants |
| +telnet-port+ : | | Internal constants |
| +thenull+ : | | Internal constants |
| +tls+ : | | Internal constants |
| +tm+ : | | Internal constants |
| +tn3270e+ : | | Internal constants |
| +tspeed+ : | | Internal constants |
| +ttyloc+ : | | Internal constants |
| +ttype+ : | | Internal constants |
| +tuid+ : | | Internal constants |
| +vt3270regime+ : | | Internal constants |
| +will+ : | | Internal constants |
| +wont+ : | | Internal constants |
| +x3pad+ : | | Internal constants |
| +xascii+ : | | Internal constants |
| +xauth+ : | | Internal constants |
| +xdisploc+ : | | Internal constants |
|
C | | |
| char-callback : | | Internal classes |
| Constant, +ao+ : | | Internal constants |
| Constant, +authentication+ : | | Internal constants |
| Constant, +ayt+ : | | Internal constants |
| Constant, +binary+ : | | Internal constants |
| Constant, +bm+ : | | Internal constants |
| Constant, +brk+ : | | Internal constants |
| Constant, +charset+ : | | Internal constants |
| Constant, +com_port_option+ : | | Internal constants |
| Constant, +det+ : | | Internal constants |
| Constant, +dm+ : | | Internal constants |
| Constant, +do+ : | | Internal constants |
| Constant, +dont+ : | | Internal constants |
| Constant, +ec+ : | | Internal constants |
| Constant, +echo+ : | | Internal constants |
| Constant, +el+ : | | Internal constants |
| Constant, +encrypt+ : | | Internal constants |
| Constant, +eor+ : | | Internal constants |
| Constant, +exopl+ : | | Internal constants |
| Constant, +forward_x+ : | | Internal constants |
| Constant, +ga+ : | | Internal constants |
| Constant, +iac+ : | | Internal constants |
| Constant, +ip+ : | | Internal constants |
| Constant, +kermit+ : | | Internal constants |
| Constant, +lflow+ : | | Internal constants |
| Constant, +linemode+ : | | Internal constants |
| Constant, +logout+ : | | Internal constants |
| Constant, +nams+ : | | Internal constants |
| Constant, +naocrd+ : | | Internal constants |
| Constant, +naoffd+ : | | Internal constants |
| Constant, +naohtd+ : | | Internal constants |
| Constant, +naohts+ : | | Internal constants |
| Constant, +naol+ : | | Internal constants |
| Constant, +naolfd+ : | | Internal constants |
| Constant, +naop+ : | | Internal constants |
| Constant, +naovtd+ : | | Internal constants |
| Constant, +naovts+ : | | Internal constants |
| Constant, +naws+ : | | Internal constants |
| Constant, +new_environ+ : | | Internal constants |
| Constant, +noopt+ : | | Internal constants |
| Constant, +nop+ : | | Internal constants |
| Constant, +old_environ+ : | | Internal constants |
| Constant, +outmrk+ : | | Internal constants |
| Constant, +pragma_heartbeat+ : | | Internal constants |
| Constant, +pragma_logon+ : | | Internal constants |
| Constant, +rcp+ : | | Internal constants |
| Constant, +rcte+ : | | Internal constants |
| Constant, +rsp+ : | | Internal constants |
| Constant, +sb+ : | | Internal constants |
| Constant, +se+ : | | Internal constants |
| Constant, +send_url+ : | | Internal constants |
| Constant, +sga+ : | | Internal constants |
| Constant, +sndloc+ : | | Internal constants |
| Constant, +sspi_logon+ : | | Internal constants |
| Constant, +status+ : | | Internal constants |
| Constant, +supdup+ : | | Internal constants |
| Constant, +supdupoutput+ : | | Internal constants |
| Constant, +suppress_local_echo+ : | | Internal constants |
| Constant, +telnet-port+ : | | Internal constants |
| Constant, +thenull+ : | | Internal constants |
| Constant, +tls+ : | | Internal constants |
| Constant, +tm+ : | | Internal constants |
| Constant, +tn3270e+ : | | Internal constants |
| Constant, +tspeed+ : | | Internal constants |
| Constant, +ttyloc+ : | | Internal constants |
| Constant, +ttype+ : | | Internal constants |
| Constant, +tuid+ : | | Internal constants |
| Constant, +vt3270regime+ : | | Internal constants |
| Constant, +will+ : | | Internal constants |
| Constant, +wont+ : | | Internal constants |
| Constant, +x3pad+ : | | Internal constants |
| Constant, +xascii+ : | | Internal constants |
| Constant, +xauth+ : | | Internal constants |
| Constant, +xdisploc+ : | | Internal constants |
| cookedq : | | Internal classes |
|
D | | |
| debug-on : | | Internal classes |
|
E | | |
| eof : | | Internal classes |
|
H | | |
| host : | | Internal classes |
|
I | | |
| iacseq : | | Internal classes |
|
O | | |
| option-callback : | | Internal classes |
|
P | | |
| port : | | Internal classes |
|
R | | |
| remove-return-char : | | Internal classes |
|
S | | |
| sb : | | Internal classes |
| sb-option-callback : | | Internal classes |
| sbdataq : | | Internal classes |
| Slot, char-callback : | | Internal classes |
| Slot, cookedq : | | Internal classes |
| Slot, debug-on : | | Internal classes |
| Slot, eof : | | Internal classes |
| Slot, host : | | Internal classes |
| Slot, iacseq : | | Internal classes |
| Slot, option-callback : | | Internal classes |
| Slot, port : | | Internal classes |
| Slot, remove-return-char : | | Internal classes |
| Slot, sb : | | Internal classes |
| Slot, sb-option-callback : | | Internal classes |
| Slot, sbdataq : | | Internal classes |
| Slot, sock-stream : | | Internal classes |
| sock-stream : | | Internal classes |
| Special Variable, *tn-internal-debug* : | | Internal special variables |
|
A.4 Data types