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 Mon Apr 19 17:59:35 2021 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

• cl-ppcre
• sb-bsd-sockets

Source

telnetlib.asd (file)

Components

• packages.lisp (file)
• telnetconst.lisp (file)
• telnetlib.lisp (file)

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

• +ao+ (constant)
• +authentication+ (constant)
• +ayt+ (constant)
• +binary+ (constant)
• +bm+ (constant)
• +brk+ (constant)
• +charset+ (constant)
• +com_port_option+ (constant)
• +det+ (constant)
• +dm+ (constant)
• +do+ (constant)
• +dont+ (constant)
• +ec+ (constant)
• +echo+ (constant)
• +el+ (constant)
• +encrypt+ (constant)
• +eor+ (constant)
• +exopl+ (constant)
• +forward_x+ (constant)
• +ga+ (constant)
• +iac+ (constant)
• +ip+ (constant)
• +kermit+ (constant)
• +lflow+ (constant)
• +linemode+ (constant)
• +logout+ (constant)
• +nams+ (constant)
• +naocrd+ (constant)
• +naoffd+ (constant)
• +naohtd+ (constant)
• +naohts+ (constant)
• +naol+ (constant)
• +naolfd+ (constant)
• +naop+ (constant)
• +naovtd+ (constant)
• +naovts+ (constant)
• +naws+ (constant)
• +new_environ+ (constant)
• +noopt+ (constant)
• +nop+ (constant)
• +old_environ+ (constant)
• +outmrk+ (constant)
• +pragma_heartbeat+ (constant)
• +pragma_logon+ (constant)
• +rcp+ (constant)
• +rcte+ (constant)
• +rsp+ (constant)
• +sb+ (constant)
• +se+ (constant)
• +send_url+ (constant)
• +sga+ (constant)
• +sndloc+ (constant)
• +sspi_logon+ (constant)
• +status+ (constant)
• +supdup+ (constant)
• +supdupoutput+ (constant)
• +suppress_local_echo+ (constant)
• +telnet-port+ (constant)
• +thenull+ (constant)
• +tls+ (constant)
• +tm+ (constant)
• +tn3270e+ (constant)
• +tspeed+ (constant)
• +ttyloc+ (constant)
• +ttype+ (constant)
• +tuid+ (constant)
• +vt3270regime+ (constant)
• +will+ (constant)
• +wont+ (constant)
• +x3pad+ (constant)
• +xascii+ (constant)
• +xauth+ (constant)
• +xdisploc+ (constant)

3.1.4 telnetlib/telnetlib.lisp

Dependency

telnetconst.lisp (file)

Parent

telnetlib (system)

Location

telnetlib.lisp

Exported Definitions

• close-telnet-session (function)
• eof-tn (function)
• expect (function)
• format-tn (function)
• open-telnet-session (function)
• peek-available-data (function)
• peek-sbdata (function)
• read-available-data (function)
• read-until (function)
• read-until-2 (function)
• read-until-2-ind (function)
• set-telnet-session-option (function)
• telnet-eof (condition)
• telnet-read-timeout (condition)
• with-telnet-session (macro)
• write-ln (function)
• write-ln-crlr (function)

Internal Definitions

• *tn-internal-debug* (special variable)
• char-callback (method)
• (setf char-callback) (method)
• char-equal-case-insensitive% (function)
• cookedq (method)
• (setf cookedq) (method)
• debug-on (method)
• (setf debug-on) (method)
• default-option-callback% (function)
• default-sb-option-callback% (function)
• eof (method)
• (setf eof) (method)
• host (method)
• (setf host) (method)
• iacseq (method)
• (setf iacseq) (method)
• option-callback (method)
• (setf option-callback) (method)
• port (method)
• (setf port) (method)
• process-sock-stream% (function)
• read-cookedq% (function)
• remove-return-char (method)
• (setf remove-return-char) (method)
• sb (method)
• (setf sb) (method)
• sb-option-callback (method)
• (setf sb-option-callback) (method)
• sbdataq (method)
• (setf sbdataq) (method)
• send-sub-terminal-type-is% (function)
• sock-stream (method)
• (setf sock-stream) (method)
• telnet (class)
• wait-until-readable% (function)

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

• close-telnet-session (function)
• eof-tn (function)
• expect (function)
• format-tn (function)
• open-telnet-session (function)
• peek-available-data (function)
• peek-sbdata (function)
• read-available-data (function)
• read-until (function)
• read-until-2 (function)
• read-until-2-ind (function)
• set-telnet-session-option (function)
• telnet-eof (condition)
• telnet-read-timeout (condition)
• with-telnet-session (macro)
• write-ln (function)
• write-ln-crlr (function)

Internal Definitions

• *tn-internal-debug* (special variable)
• +ao+ (constant)
• +authentication+ (constant)
• +ayt+ (constant)
• +binary+ (constant)
• +bm+ (constant)
• +brk+ (constant)
• +charset+ (constant)
• +com_port_option+ (constant)
• +det+ (constant)
• +dm+ (constant)
• +do+ (constant)
• +dont+ (constant)
• +ec+ (constant)
• +echo+ (constant)
• +el+ (constant)
• +encrypt+ (constant)
• +eor+ (constant)
• +exopl+ (constant)
• +forward_x+ (constant)
• +ga+ (constant)
• +iac+ (constant)
• +ip+ (constant)
• +kermit+ (constant)
• +lflow+ (constant)
• +linemode+ (constant)
• +logout+ (constant)
• +nams+ (constant)
• +naocrd+ (constant)
• +naoffd+ (constant)
• +naohtd+ (constant)
• +naohts+ (constant)
• +naol+ (constant)
• +naolfd+ (constant)
• +naop+ (constant)
• +naovtd+ (constant)
• +naovts+ (constant)
• +naws+ (constant)
• +new_environ+ (constant)
• +noopt+ (constant)
• +nop+ (constant)
• +old_environ+ (constant)
• +outmrk+ (constant)
• +pragma_heartbeat+ (constant)
• +pragma_logon+ (constant)
• +rcp+ (constant)
• +rcte+ (constant)
• +rsp+ (constant)
• +sb+ (constant)
• +se+ (constant)
• +send_url+ (constant)
• +sga+ (constant)
• +sndloc+ (constant)
• +sspi_logon+ (constant)
• +status+ (constant)
• +supdup+ (constant)
• +supdupoutput+ (constant)
• +suppress_local_echo+ (constant)
• +telnet-port+ (constant)
• +thenull+ (constant)
• +tls+ (constant)
• +tm+ (constant)
• +tn3270e+ (constant)
• +tspeed+ (constant)
• +ttyloc+ (constant)
• +ttype+ (constant)
• +tuid+ (constant)
• +vt3270regime+ (constant)
• +will+ (constant)
• +wont+ (constant)
• +x3pad+ (constant)
• +xascii+ (constant)
• +xauth+ (constant)
• +xdisploc+ (constant)
• char-callback (generic function)
• char-callback (method)
• (setf char-callback) (method)
• (setf char-callback) (generic function)
• char-equal-case-insensitive% (function)
• cookedq (generic function)
• cookedq (method)
• (setf cookedq) (method)
• (setf cookedq) (generic function)
• debug-on (generic function)
• debug-on (method)
• (setf debug-on) (method)
• (setf debug-on) (generic function)
• default-option-callback% (function)
• default-sb-option-callback% (function)
• eof (generic function)
• eof (method)
• (setf eof) (method)
• (setf eof) (generic function)
• host (generic function)
• host (method)
• (setf host) (method)
• (setf host) (generic function)
• iacseq (generic function)
• iacseq (method)
• (setf iacseq) (method)
• (setf iacseq) (generic function)
• option-callback (generic function)
• option-callback (method)
• (setf option-callback) (method)
• (setf option-callback) (generic function)
• port (generic function)
• port (method)
• (setf port) (method)
• (setf port) (generic function)
• process-sock-stream% (function)
• read-cookedq% (function)
• remove-return-char (generic function)
• remove-return-char (method)
• (setf remove-return-char) (method)
• (setf remove-return-char) (generic function)
• sb (generic function)
• sb (method)
• (setf sb) (method)
• (setf sb) (generic function)
• sb-option-callback (generic function)
• sb-option-callback (method)
• (setf sb-option-callback) (method)
• (setf sb-option-callback) (generic function)
• sbdataq (generic function)
• sbdataq (method)
• (setf sbdataq) (method)
• (setf sbdataq) (generic function)
• send-sub-terminal-type-is% (function)
• sock-stream (generic function)
• sock-stream (method)
• (setf sock-stream) (method)
• (setf sock-stream) (generic function)
• telnet (class)
• wait-until-readable% (function)

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

• debug-on (method)
• debug-on (method)
• remove-return-char (method)
• remove-return-char (method)
• char-callback (method)
• char-callback (method)
• sb-option-callback (method)
• sb-option-callback (method)
• option-callback (method)
• option-callback (method)
• sbdataq (method)
• sbdataq (method)
• sb (method)
• sb (method)
• iacseq (method)
• iacseq (method)
• eof (method)
• eof (method)
• cookedq (method)
• cookedq (method)
• sock-stream (method)
• sock-stream (method)
• port (method)
• port (method)
• host (method)
• host (method)

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

A.2 Functions

A.3 Variables

A.4 Data types