The cl-libssh2 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-libssh2 Reference Manual

This is the cl-libssh2 Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:09:04 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

1.1 libssh2

Author

Oleksii Shevchuk <alxchk@gmail.com>

License

Public Domain

Description

Trivial libssh2 bindings

Version

0.1

Dependencies
Source

libssh2.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

2 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

2.1 libssh2/src

Parent

libssh2 (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 libssh2.asd

Location

libssh2.asd

Systems

libssh2 (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 libssh2/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

libssh2


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 libssh2/src/logging.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/logging.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 libssh2/src/types.lisp

Dependency

logging.lisp (file)

Parent

src (module)

Location

src/types.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 libssh2/src/libssh2-libc-cffi.lisp

Dependency

types.lisp (file)

Parent

src (module)

Location

src/libssh2-libc-cffi.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 libssh2/src/util.lisp

Dependency

libssh2-libc-cffi.lisp (file)

Parent

src (module)

Location

src/util.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 libssh2/src/libssh2-cffi.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/libssh2-cffi.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 libssh2/src/streams.lisp

Dependency

libssh2-cffi.lisp (file)

Parent

src (module)

Location

src/streams.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 libssh2/src/scp.lisp

Dependency

streams.lisp (file)

Parent

src (module)

Location

src/scp.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.10 libssh2/src/sftp.lisp

Dependency

scp.lisp (file)

Parent

src (module)

Location

src/sftp.lisp

Exported Definitions

sftp-list-directory (function)

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.11 libssh2/src/solutions.lisp

Dependency

sftp.lisp (file)

Parent

src (module)

Location

src/solutions.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 libssh2

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *channel-read-type*
Package

libssh2

Source

libssh2-cffi.lisp (file)

Special Variable: *channel-read-zero-as-eof*
Package

libssh2

Source

libssh2-cffi.lisp (file)

Special Variable: *default-errors-list*
Package

libssh2

Source

types.lisp (file)

Special Variable: *errors-list*
Package

libssh2

Source

types.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: foreach-agent-identity (IDENTY AGENT) &body BODY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Macro: with-agent (AGENT SESSION) &body BODY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Macro: with-execute (STDIO-STREAM SSH-CONNECTION COMMAND) &body BODY
Package

libssh2

Source

streams.lisp (file)

Macro: with-execute* (STDIO-STREAM SSH-CONNECTION COMMAND) &body BODY
Package

libssh2

Source

streams.lisp (file)

Macro: with-known-hosts (KNOWN-HOSTS (SESSION KNOWN-HOSTS-FILENAME)) &body BODY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Macro: with-scp-input (ISTREAM SSH-CONNECTION PATH OBJECT-STAT) &body BODY
Package

libssh2

Source

streams.lisp (file)

Macro: with-scp-output (OSTREAM SSH-CONNECTION PATH SIZE &key MTIME ATIME MODE) &body BODY
Package

libssh2

Source

streams.lisp (file)

Macro: with-session (SESSION) &body BODY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Macro: with-ssh-connection SESSION (HOST AUTH-DATA &rest CONNECTION-ARGS) &body BODY
Package

libssh2

Source

streams.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: agent-connect AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: agent-disconnect AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: agent-free AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: agent-identities-iterator AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: agent-init SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: agent-list-identies AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-close CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-eofp CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-exec CHANNEL CMD
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-exit-status CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-flush CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-free CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-open SESSION &key CHANNEL-TYPE WINDOW-SIZE PACKET-SIZE MESSAGE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-process-start CHANNEL REQUEST MESSAGE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-read CHANNEL OUTPUT-BUFFER &key START END TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-scp-recv SESSION PATH
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-send-eof CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-setenv CHANNEL NAME VALUE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-shell CHANNEL CMD
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-subsystem CHANNEL CMD
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-wait-closed CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-write CHANNEL DATA &key START END TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-write-string CHANNEL DATA &key START END TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: known-hosts-add KNOWN-HOSTS HOST-FULL-STRING KEY &key COMMENT FLAGS SALT STORE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: known-hosts-check KNOWN-HOSTS HOSTNAME KEY &key PORT FLAGS KNOWN-HOST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: known-hosts-free KNOWN-HOSTS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: known-hosts-init SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: known-hosts-readfile HOSTS FILE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: known-hosts-writefile HOSTS FILE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: make-agent-auth LOGIN
Package

libssh2

Source

streams.lisp (file)

Function: make-auth-data LOGIN &key KEY-DIRECTORIES KEYS PASSWORDS
Package

libssh2

Source

solutions.lisp (file)

Function: make-password-auth LOGIN PASSWORD
Package

libssh2

Source

streams.lisp (file)

Function: make-password-emul-auth LOGIN PASSWORD
Package

libssh2

Source

streams.lisp (file)

Function: make-publickey-auth LOGIN DIRECTORY PRIVATE-KEY-NAME &optional PASSWORD
Package

libssh2

Source

streams.lisp (file)

Function: scp-get REMOTE-NAME LOCAL-NAME &optional CONNECTION
Package

libssh2

Source

scp.lisp (file)

Function: scp-put LOCAL-NAME REMOTE-NAME &optional CONNECTION
Package

libssh2

Source

scp.lisp (file)

Function: session-auth-methods-list SESSION USERNAME
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-disconnect SESSION &key REASON DESCRIPTION LANG
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-handshake SESSION SOCKET
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-hostkey SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-hostkey-fingerprint SESSION &optional TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-init ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-last-error SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: sftp-list-directory SSH-CONNECTION PATH &key MAXFILES EXTENSIONS

Return a list of files in directory ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’. Restrict the number of files to retrieve by providing
- ‘MAXFILES’ - a fixnum (which is by default set to an insanely large number)
- ‘EXTENSIONS’ - a list of strings (default: nil)

It is possible to combine ‘MAXFILES’ and ‘EXTENSIONS’ (retrieve 5 files with extensions ’(".json", ".js"))

Package

libssh2

Source

sftp.lisp (file)

Function: user-auth-agent AGENT USERNAME IDENTITY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: user-auth-password SESSION USERNAME PASSWORD &optional CALLBACK
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: user-auth-publickey SESSION USERNAME PUBLIC-KEY PRIVATE-KEY PASSWORD
Package

libssh2

Source

libssh2-cffi.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: auth-passed OBJECT
Generic Function: (setf auth-passed) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: auth-passed (SSH-CONNECTION ssh-connection)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf auth-passed) NEW-VALUE (SSH-CONNECTION ssh-connection)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: authentication SSH AUTH
Package

libssh2

Methods
Method: authentication (SSH ssh-connection) (AUTH-LIST list)
Source

solutions.lisp (file)

Method: authentication (SSH ssh-connection) (AUTH auth-agent)
Source

streams.lisp (file)

Method: authentication (SSH ssh-connection) (AUTH auth-publickey)
Source

streams.lisp (file)

Method: authentication (SSH ssh-connection) (AUTH auth-password-emul)
Source

streams.lisp (file)

Method: authentication (SSH ssh-connection) (AUTH auth-password)
Source

streams.lisp (file)

Method: authentication (SSH ssh-connection) (AUTH auth-data) around
Source

streams.lisp (file)

Generic Function: authentication-methods SSH LOGIN
Package

libssh2

Methods
Method: authentication-methods (SSH ssh-connection) (LOGIN string)
Source

streams.lisp (file)

Generic Function: channel OBJECT
Generic Function: (setf channel) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: channel (SSH-CHANNEL-STREAM ssh-channel-stream)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf channel) NEW-VALUE (SSH-CHANNEL-STREAM ssh-channel-stream)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: code CONDITION
Generic Function: (setf code) NEW-VALUE CONDITION
Package

libssh2

Methods
Method: code (CONDITION ssh-condition)
Method: (setf code) NEW-VALUE (CONDITION ssh-condition)
Source

types.lisp (file)

Generic Function: create-ssh-connection HOST &key HOSTS-DB PORT READ-TIMEOUT WRITE-TIMEOUT
Package

libssh2

Methods
Method: create-ssh-connection HOST &key HOSTS-DB PORT READ-TIMEOUT WRITE-TIMEOUT
Source

streams.lisp (file)

Generic Function: destroy-ssh-connection SSH &key DESCRIPTION LANG
Package

libssh2

Methods
Method: destroy-ssh-connection (SSH ssh-connection) &key DESCRIPTION LANG
Source

streams.lisp (file)

Generic Function: execute SSH COMMAND
Package

libssh2

Methods
Method: execute (SSH ssh-connection) (COMMAND string)
Source

streams.lisp (file)

Generic Function: file CONDITION
Generic Function: (setf file) NEW-VALUE CONDITION
Package

libssh2

Methods
Method: file (CONDITION known-hosts-reading-error)
Method: (setf file) NEW-VALUE (CONDITION known-hosts-reading-error)
Source

libssh2-cffi.lisp (file)

Generic Function: hash CONDITION
Generic Function: (setf hash) NEW-VALUE CONDITION
Package

libssh2

Methods
Method: hash (CONDITION ssh-hostkey-condition)
Method: (setf hash) NEW-VALUE (CONDITION ssh-hostkey-condition)
Source

types.lisp (file)

Generic Function: host CONDITION
Generic Function: (setf host) NEW-VALUE CONDITION
Package

libssh2

Methods
Method: host (SSH-CONNECTION ssh-connection)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf host) NEW-VALUE (SSH-CONNECTION ssh-connection)

automatically generated writer method

Source

streams.lisp (file)

Method: host (CONDITION ssh-hostkey-condition)
Method: (setf host) NEW-VALUE (CONDITION ssh-hostkey-condition)
Source

types.lisp (file)

Generic Function: hosts-db OBJECT
Generic Function: (setf hosts-db) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: hosts-db (SSH-CONNECTION ssh-connection)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf hosts-db) NEW-VALUE (SSH-CONNECTION ssh-connection)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: input-buffer OBJECT
Generic Function: (setf input-buffer) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: input-buffer (SSH-CHANNEL-STREAM-INPUT ssh-channel-stream-input)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf input-buffer) NEW-VALUE (SSH-CHANNEL-STREAM-INPUT ssh-channel-stream-input)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: input-size OBJECT
Generic Function: (setf input-size) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: input-size (SSH-CHANNEL-STREAM-INPUT ssh-channel-stream-input)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf input-size) NEW-VALUE (SSH-CHANNEL-STREAM-INPUT ssh-channel-stream-input)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: message CONDITION
Generic Function: (setf message) NEW-VALUE CONDITION
Package

libssh2

Methods
Method: message (CONDITION ssh-condition)
Method: (setf message) NEW-VALUE (CONDITION ssh-condition)
Source

types.lisp (file)

Generic Function: output-buffer OBJECT
Generic Function: (setf output-buffer) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: output-buffer (SSH-CHANNEL-STREAM-OUTPUT ssh-channel-stream-output)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf output-buffer) NEW-VALUE (SSH-CHANNEL-STREAM-OUTPUT ssh-channel-stream-output)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: output-pos OBJECT
Generic Function: (setf output-pos) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: output-pos (SSH-CHANNEL-STREAM-OUTPUT ssh-channel-stream-output)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf output-pos) NEW-VALUE (SSH-CHANNEL-STREAM-OUTPUT ssh-channel-stream-output)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: output-size OBJECT
Generic Function: (setf output-size) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: output-size (SSH-CHANNEL-STREAM-OUTPUT ssh-channel-stream-output)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf output-size) NEW-VALUE (SSH-CHANNEL-STREAM-OUTPUT ssh-channel-stream-output)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: password OBJECT
Generic Function: (setf password) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: password (AUTH-PUBLICKEY auth-publickey)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf password) NEW-VALUE (AUTH-PUBLICKEY auth-publickey)

automatically generated writer method

Source

streams.lisp (file)

Method: password (AUTH-PASSWORD-EMUL auth-password-emul)

automatically generated reader method

Source

streams.lisp (file)

Method: password (AUTH-PASSWORD auth-password)

automatically generated reader method

Source

streams.lisp (file)

Generic Function: port OBJECT
Generic Function: (setf port) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: port (SSH-CONNECTION ssh-connection)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf port) NEW-VALUE (SSH-CONNECTION ssh-connection)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: private-key OBJECT
Generic Function: (setf private-key) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: private-key (AUTH-PUBLICKEY auth-publickey)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf private-key) NEW-VALUE (AUTH-PUBLICKEY auth-publickey)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: public-key OBJECT
Generic Function: (setf public-key) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: public-key (AUTH-PUBLICKEY auth-publickey)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf public-key) NEW-VALUE (AUTH-PUBLICKEY auth-publickey)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: reason CONDITION
Generic Function: (setf reason) NEW-VALUE CONDITION
Package

libssh2

Methods
Method: reason (CONDITION ssh-bad-hostkey)
Method: (setf reason) NEW-VALUE (CONDITION ssh-bad-hostkey)
Source

types.lisp (file)

Generic Function: scp-input SSH PATH
Package

libssh2

Methods
Method: scp-input (SSH ssh-connection) (PATH string)
Source

streams.lisp (file)

Generic Function: scp-output SSH PATH SIZE &key MODE MTIME ATIME
Package

libssh2

Methods
Method: scp-output (SSH ssh-connection) (PATH string) SIZE &key MODE MTIME ATIME
Source

streams.lisp (file)

Generic Function: session OBJECT
Package

libssh2

Methods
Method: session (SSH-CONNECTION ssh-connection)

automatically generated reader method

Source

streams.lisp (file)

Generic Function: socket OBJECT
Generic Function: (setf socket) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: socket (SSH-CHANNEL-STREAM ssh-channel-stream)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf socket) NEW-VALUE (SSH-CHANNEL-STREAM ssh-channel-stream)

automatically generated writer method

Source

streams.lisp (file)

Method: socket (SSH-CONNECTION ssh-connection)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf socket) NEW-VALUE (SSH-CONNECTION ssh-connection)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: ssh-session-key SSH
Package

libssh2

Methods
Method: ssh-session-key (SSH ssh-connection)
Source

streams.lisp (file)

Generic Function: ssh-verify-session SSH
Package

libssh2

Methods
Method: ssh-verify-session (SSH ssh-connection)
Source

streams.lisp (file)

Generic Function: stream-finish-output* STREAM &key DONT-SEND-EOF
Package

libssh2

Methods
Method: stream-finish-output* (STREAM ssh-channel-stream-output) &key DONT-SEND-EOF
Source

streams.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: known-hosts-reading-error ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Direct superclasses

ssh-generic-error (condition)

Direct methods
  • print-object (method)
  • file (method)
  • file (method)
Direct slots
Slot: file
Initargs

:file

Readers

file (generic function)

Writers

(setf file) (generic function)

Condition: ssh-bad-hostkey ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses
Direct methods
  • reason (method)
  • reason (method)
Direct slots
Slot: reason
Initargs

:reason

Readers

reason (generic function)

Writers

(setf reason) (generic function)

Condition: ssh-generic-error ()

Signalled when a non-correctable condition occurs during a libssh2 call.

Package

libssh2

Source

types.lisp (file)

Direct superclasses
Direct subclasses
Condition: ssh-handshake-error ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses

ssh-generic-error (condition)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Structures

Structure: key ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: data
Initform

0

Readers

key-data (function)

Writers

(setf key-data) (function)

Slot: size
Initform

0

Readers

key-size (function)

Writers

(setf key-size) (function)

Slot: type
Initform

0

Readers

key-type (function)

Writers

(setf key-type) (function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.7 Classes

Class: auth-agent ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

auth-data (class)

Direct methods
Class: auth-data ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: login
Type

string

Initargs

:login

Initform

""

Readers

login (generic function)

Class: auth-password ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

auth-data (class)

Direct methods
Direct slots
Slot: password
Type

string

Initargs

:password

Initform

""

Readers

password (generic function)

Class: auth-publickey ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

auth-data (class)

Direct methods
Direct slots
Slot: public-key
Type

string

Initargs

:public-key

Initform

"id_rsa.pub"

Readers

public-key (generic function)

Writers

(setf public-key) (generic function)

Slot: private-key
Type

string

Initargs

:private-key

Initform

"id_rsa"

Readers

private-key (generic function)

Writers

(setf private-key) (generic function)

Slot: password
Type

string

Initargs

:password

Initform

""

Readers

password (generic function)

Writers

(setf password) (generic function)

Class: ssh-channel-exec ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses
  • fundamental-character-input-stream (class)
  • fundamental-binary-input-stream (class)
  • fundamental-character-output-stream (class)
  • fundamental-binary-output-stream (class)
  • ssh-channel-stream-input/output (class)
Class: ssh-channel-recv ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses
Direct methods

stream-read-sequence (method)

Class: ssh-channel-send ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses
Class: ssh-channel-stream ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

trivial-gray-stream-mixin (class)

Direct subclasses
Direct methods
  • close (method)
  • stream-force-output (method)
  • stream-finish-output (method)
  • stream-listen (method)
  • open-stream-p (method)
  • stream-element-type (method)
  • channel (method)
  • channel (method)
  • socket (method)
  • socket (method)
Direct slots
Slot: socket
Initargs

:socket

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: channel
Type

libssh2:+channel+

Initargs

:channel

Readers

channel (generic function)

Writers

(setf channel) (generic function)

Class: ssh-channel-stream-input ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

ssh-channel-stream (class)

Direct subclasses
Direct methods
  • stream-read-line (method)
  • stream-read-sequence (method)
  • stream-read-byte (method)
  • input-pos (method)
  • input-pos (method)
  • input-size (method)
  • input-size (method)
  • input-buffer (method)
  • input-buffer (method)
Direct slots
Slot: input-buffer
Initform

(cffi-sys:make-shareable-byte-vector libssh2::*ssh-channel-buffer-size*)

Readers

input-buffer (generic function)

Writers

(setf input-buffer) (generic function)

Slot: input-size
Type

libssh2::int

Initform

0

Readers

input-size (generic function)

Writers

(setf input-size) (generic function)

Slot: input-pos
Type

libssh2::int

Initform

0

Readers

input-pos (generic function)

Writers

(setf input-pos) (generic function)

Class: ssh-channel-stream-input/output ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses
Direct subclasses

ssh-channel-exec (class)

Class: ssh-channel-stream-output ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

ssh-channel-stream (class)

Direct subclasses
Direct methods
  • stream-write-sequence (method)
  • stream-write-sequence (method)
  • stream-write-char (method)
  • stream-write-byte (method)
  • stream-force-output (method)
  • stream-finish-output (method)
  • stream-finish-output* (method)
  • output-pos (method)
  • output-pos (method)
  • output-size (method)
  • output-size (method)
  • output-buffer (method)
  • output-buffer (method)
Direct slots
Slot: output-buffer
Initform

(cffi-sys:make-shareable-byte-vector libssh2::*ssh-channel-buffer-size*)

Readers

output-buffer (generic function)

Writers

(setf output-buffer) (generic function)

Slot: output-size
Type

libssh2::int

Initform

0

Readers

output-size (generic function)

Writers

(setf output-size) (generic function)

Slot: output-pos
Type

libssh2::int

Initform

0

Readers

output-pos (generic function)

Writers

(setf output-pos) (generic function)

Class: ssh-connection ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: session
Type

libssh2:+session+

Initargs

:session

Initform

(cffi-sys:null-pointer)

Readers

session (generic function)

Slot: socket
Type

usocket:socket

Initargs

:socket

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: host
Type

string

Initargs

:host

Readers

host (generic function)

Writers

(setf host) (generic function)

Slot: port
Type

libssh2::int

Initargs

:port

Readers

port (generic function)

Writers

(setf port) (generic function)

Slot: hosts-db
Type

string

Initargs

:hosts-db

Readers

hosts-db (generic function)

Writers

(setf hosts-db) (generic function)

Slot: auth-passed
Type

boolean

Readers

auth-passed (generic function)

Writers

(setf auth-passed) (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +sftp-read-buffer-size+
Package

libssh2

Source

sftp.lisp (file)

Constant: .auth.
Package

libssh2

Source

types.lisp (file)

Constant: .base64.
Package

libssh2

Source

types.lisp (file)

Constant: .conn.
Package

libssh2

Source

types.lisp (file)

Constant: .error.
Package

libssh2

Source

types.lisp (file)

Constant: .kex.
Package

libssh2

Source

types.lisp (file)

Constant: .publickey
Package

libssh2

Source

types.lisp (file)

Constant: .raw.
Package

libssh2

Source

types.lisp (file)

Constant: .rsa1.
Package

libssh2

Source

types.lisp (file)

Constant: .scp.
Package

libssh2

Source

types.lisp (file)

Constant: .sftp.
Package

libssh2

Source

types.lisp (file)

Constant: .socket
Package

libssh2

Source

types.lisp (file)

Constant: .ssh.
Package

libssh2

Source

types.lisp (file)

Constant: .trans.
Package

libssh2

Source

types.lisp (file)

Constant: .type-plain.
Package

libssh2

Source

types.lisp (file)

Constant: .type-sha1.
Package

libssh2

Source

types.lisp (file)

Constant: size-of-+stat+
Package

libssh2

Source

/home/quickbuilder/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickbuilder/quicklisp/dists/quicklisp/software/cl-libssh2-20160531-git/src/libssh2-libc-cffi.processed-grovel-file


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *config-directory*
Package

libssh2

Source

util.lisp (file)

Special Variable: *keyboard-interactive-password*
Package

libssh2

Source

libssh2-cffi.lisp (file)

Special Variable: *session*
Package

libssh2

Source

solutions.lisp (file)

Special Variable: *sftp-session*

Dynamic variable which is bound to a foreign reference representing the SFTP session (in libssh2 terms).

Package

libssh2

Source

libssh2-cffi.lisp (file)

Special Variable: *ssh-channel-buffer-size*
Package

libssh2

Source

streams.lisp (file)

Special Variable: *ssh-connection*

Dynamic variable which holds an instance of SSH-CONNECTION which is a wrapper around the libssh2 ’session’ pointer, and contains additional information about host, port etc.

Package

libssh2

Source

libssh2-cffi.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: channel-write-with-conv NAME CONV
Package

libssh2

Source

libssh2-cffi.lisp (file)

Macro: defcfun-error-check (C-FUNCTION-NAME LISP-FUNCTION-NAME) RESULT-TYPE &rest REST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Macro: result-or-error &body BODY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Macro: ssh2.debug MESSAGE-CONTROL &rest MESSAGE-ARGS
Package

libssh2

Source

logging.lisp (file)

Macro: ssh2.dribble MESSAGE-CONTROL &rest MESSAGE-ARGS
Package

libssh2

Source

logging.lisp (file)

Macro: ssh2.error MESSAGE-CONTROL &rest MESSAGE-ARGS
Package

libssh2

Source

logging.lisp (file)

Macro: ssh2.fatal MESSAGE-CONTROL &rest MESSAGE-ARGS
Package

libssh2

Source

logging.lisp (file)

Macro: ssh2.info MESSAGE-CONTROL &rest MESSAGE-ARGS
Package

libssh2

Source

logging.lisp (file)

Macro: ssh2.warn MESSAGE-CONTROL &rest MESSAGE-ARGS
Package

libssh2

Source

logging.lisp (file)

Macro: with-last-error (SESSION ERROR-TYPE) &rest ARGS
Package

libssh2

Source

streams.lisp (file)

Macro: with-sftp (SFTP-SESSION SSH-CONNECTION) &body BODY
Package

libssh2

Source

sftp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: %agent-connect AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %agent-disconnect AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %agent-get-identity AGENT STORE PREVIOUS-PUBLIC-KEY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %agent-init SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %agent-list-identies AGENT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %agent-userauth AGENT USERNAME IDENTITY
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-close CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-eofp CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-flush-ex CHANNEL STREAM
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-free CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-open-ex SESSION CHANNEL-TYPE CHANNEL-TYPE-LENGTH WINDOW-SIZE PACKET-SIZE MESSAGE MESSAGE-LENGTH
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-process-startup CHANNEL REQUEST REQUEST-LENGTH MESSAGE MESSAGE-LENGTH
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-read-ex CHANNEL STREAM BUFFER BUFFER-LENGTH
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-send-eof CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-setenv-ex CHANNEL VARNAME VARNAME-LEN VALUE VALUE-LEN
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-wait-closed CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-wait-eof CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %channel-write-ex CHANNEL STREAM BUFFER BUFFER-LENGTH
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %known-hosts-addc KNOWN-HOSTS HOST SALT KEY KEY-LENGTH COMMENT COMMENT-LENGTH TYPEMASK KNOWN-HOST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %known-hosts-check KNOWN-HOSTS HOSTNAME KEY KEY-DATA-SIZE TYPE KNOWN-HOST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %known-hosts-checkp KNOWN-HOSTS HOSTNAME PORT KEY KEY-DATA-SIZE TYPE KNOWN-HOST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %known-hosts-init SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %known-hosts-readfile KNOWN-HOSTS FILENAME TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %known-hosts-writefile KNOWN-HOSTS FILENAME TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %library-init ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %library-version REQUIRED
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-close-handle HANDLE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-fstat-ex HANDLE ATTRS SETSTAT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-fstatvfs HANDLE ST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-get-channel SFTP
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-init SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-mkdir-ex SFTP PATH PATH-LEN MODE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-open-ex SFTP FILENAME FILENAME-LEN FLAGS MODE OPEN-TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-read HANDLE BUFFER BUFFER-MAXLEN
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-readdir-ex HANDLE BUFFER BUFFER-MAXLEN LONGENTRY LONGENTRY-MAXLEN ATTRS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-rename-ex SFTP SOURCE-FILENAME SOURCE-FILENAME-LEN DEST-FILENAME DEST-FILENAME-LEN FLAGS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-rmdir-ex SFTP PATH PATH-LEN
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-seek HANDLE OFFSET
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-seek-64 HANDLE OFFSET
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-shutdown SFTP
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-stat-ex SFTP PATH PATH-LEN STAT-TYPE ATTRS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-statvfs SFTP PATH PATH-LEN ST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-symlink-ex SFTP PATH PATH-LEN TARGET TARGET-LEN LINK-TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-tell HANDLE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-tell-64 HANDLE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-unlink-ex SFTP FILENAME FILENAME-LEN
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %libssh2-sftp-write HANDLE BUFFER COUNT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %scp-recv SESSION PATH STAT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %scp-send-ex SESSION PATH MODE SIZE MTIME ATIME
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %session-auth-methods-list SESSION USERNAME USERNAME-LENGTH
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %session-disconnect SESSION REASON DESCRIPTION LANG
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %session-free SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %session-handshake SESSION SOCKET
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %session-hostkey SESSION LEN TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %session-last-error SESSION ERROR-MESSAGE ERROR-MESSAGE-BUFFER-SIZE OWNERSHIP
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %user-auth-interactive SESSION USERNAME USERNAME-LENGTH CALLBACK
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %user-auth-password SESSION USERNAME USERNAME-LENGTH PASSWORD PASSWORD-LENGTH PASSWORD-CHANGE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: %user-auth-publickey SESSION USERNAME USERNAME-LEN PUBLIC-KEY PRIVATE-KEY PASSWORD
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-scp-send SESSION PATH SIZE &key MODE MTIME ATIME
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: channel-wait-eof CHANNEL
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: copy-key INSTANCE
Package

libssh2

Source

types.lisp (file)

Function: default-config-directory ()
Package

libssh2

Source

util.lisp (file)

Function: default-known-hosts ()
Package

libssh2

Source

util.lisp (file)

Function: default-private-key ()
Package

libssh2

Source

util.lisp (file)

Function: default-public-key ()
Package

libssh2

Source

util.lisp (file)

Function: ends-with-any? NAME EXTENSIONS
Package

libssh2

Source

sftp.lisp (file)

Function: ends-with? NAME EXTENSION
Package

libssh2

Source

sftp.lisp (file)

Function: get-universal-unix-time ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: key-data INSTANCE
Package

libssh2

Source

types.lisp (file)

Function: key-p OBJECT
Package

libssh2

Source

types.lisp (file)

Function: key-size INSTANCE
Package

libssh2

Source

types.lisp (file)

Function: key-type INSTANCE
Package

libssh2

Source

types.lisp (file)

Function: library-exit ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: library-init ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: library-trace SESSION OPTIONS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-close-handle HANDLE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-fstat-ex HANDLE ATTRS SETSTAT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-fstatvfs HANDLE ST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-get-channel SFTP
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-init SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-last-error SFTP
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-mkdir-ex SFTP PATH MODE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-open-ex SFTP FILENAME FLAGS MODE OPEN-TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-read HANDLE BUFFER BUFFER-MAXLEN
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-readdir-ex HANDLE BUFFER BUFFER-MAXLEN LONGENTRY LONGENTRY-MAXLEN ATTRS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-rename-ex SFTP SOURCE DEST FLAGS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-rmdir-ex SFTP PATH
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-seek HANDLE OFFSET
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-seek-64 HANDLE OFFSET
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-shutdown SFTP
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-stat-ex SFTP PATH STAT-TYPE ATTRS
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-statvfs SFTP PATH ST
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-symlink-ex SFTP SOURCE TARGET LINK-TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-tell HANDLE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-tell-64 HANDLE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-unlink-ex SFTP FILENAME
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: libssh2-sftp-write HANDLE BUFFER COUNT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: make-key &key (DATA DATA) (SIZE SIZE) (TYPE TYPE)
Package

libssh2

Source

types.lisp (file)

Function: print-memory ADDR SIZE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-free SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-hostkey-hash SESSION HASH-TYPE
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-init-ex ALLOC FREE REALLOC ABSTRACT
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-last-errno SESSION
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: session-set-blocking SESSION BLOCKING
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: set-timeouts USOCKET READ-TIMEOUT WRITE-TIMEOUT

Sets up timeouts on the given USOCKET object. READ-TIMEOUT is the read timeout period, WRITE-TIMEOUT is the write timeout, specified in (fractional) seconds. The timeouts can either be implemented using the low-level socket options SO_RCVTIMEO and SO_SNDTIMEO or some other, implementation specific mechanism. On platforms that do not support separate read and write timeouts, both must be equal or an error will be signaled. READ-TIMEOUT and WRITE-TIMEOUT may be NIL, which means that the corresponding socket timeout value will not be set.

Package

libssh2

Source

util.lisp (file)

Function: sftp-delete SSH-CONNECTION REMOTE-PATH

Delete a remote file ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’.

Package

libssh2

Source

sftp.lisp (file)

Function: sftp-get SSH-CONNECTION REMOTE-PATH LOCAL-PATH

Receive a remote file ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’ to a local file at ‘LOCAL-PATH’.

Package

libssh2

Source

sftp.lisp (file)

Function: throw-last-error SESSION
Package

libssh2

Source

streams.lisp (file)

Function: user-auth-interactive SESSION USERNAME CALLBACK
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: user-auth-interactive-trivial SESSION USERNAME PASSWORD
Package

libssh2

Source

libssh2-cffi.lisp (file)

Function: usocket-get-fd USO
Package

libssh2

Source

util.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: input-pos OBJECT
Generic Function: (setf input-pos) NEW-VALUE OBJECT
Package

libssh2

Methods
Method: input-pos (SSH-CHANNEL-STREAM-INPUT ssh-channel-stream-input)

automatically generated reader method

Source

streams.lisp (file)

Method: (setf input-pos) NEW-VALUE (SSH-CHANNEL-STREAM-INPUT ssh-channel-stream-input)

automatically generated writer method

Source

streams.lisp (file)

Generic Function: login OBJECT
Package

libssh2

Methods
Method: login (AUTH-DATA auth-data)

automatically generated reader method

Source

streams.lisp (file)

Generic Function: method-of AUTH
Package

libssh2

Methods
Method: method-of (AUTH auth-agent)
Source

solutions.lisp (file)

Method: method-of (AUTH auth-publickey)
Source

solutions.lisp (file)

Method: method-of (AUTH auth-password)
Source

solutions.lisp (file)

Generic Function: ssh-host+port-format SSH
Package

libssh2

Methods
Method: ssh-host+port-format (SSH ssh-connection)
Source

streams.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Conditions

Condition: libssh2-invalid-error-code ()

Signalled when an error code is returned by libssh2
which is unknown (or better: not yet known) to this library; this situation can arise when libssh2 adds a new error, but the lisp code is not yet updated to reflect the change. The ‘MESSAGE’ slot is set to ’Received unknown error code from libssh2; please contact the cl-libssh2 authors.’

Package

libssh2

Source

types.lisp (file)

Direct superclasses

ssh-generic-error (condition)

Direct methods

initialize-instance (method)

Condition: ssh-authentication-failure ()

is thrown in case authentication failed without specific error code~%

Package

libssh2

Source

streams.lisp (file)

Direct superclasses

ssh-generic-error (condition)

Condition: ssh-condition ()

Parent condition for all situations where a libssh2
call yields a non-zero return value. ‘CODE’ and ‘MESSAGE’ are used to transport the error code and message from C.

Package

libssh2

Source

types.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Direct methods
  • code (method)
  • code (method)
  • message (method)
  • message (method)
Direct slots
Slot: message
Initargs

:message

Readers

message (generic function)

Writers

(setf message) (generic function)

Slot: code
Initargs

:code

Readers

code (generic function)

Writers

(setf code) (generic function)

Condition: ssh-hostkey-condition ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses

ssh-condition (condition)

Direct subclasses
Direct methods
  • hash (method)
  • hash (method)
  • host (method)
  • host (method)
Direct slots
Slot: host
Initargs

:host

Readers

host (generic function)

Writers

(setf host) (generic function)

Slot: hash
Initargs

:hash

Readers

hash (generic function)

Writers

(setf hash) (generic function)

Condition: ssh-unknown-hostkey ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses

ssh-hostkey-condition (condition)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.7 Classes

Class: +kbd-prompt+-tclass ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: +kbd-response+-tclass ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: +known-host+-tclass ()
Package

libssh2

Source

types.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: +stat+-tclass ()
Package

libssh2

Source

/home/quickbuilder/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickbuilder/quicklisp/dists/quicklisp/software/cl-libssh2-20160531-git/src/libssh2-libc-cffi.processed-grovel-file

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: _libssh2-sftp-attributes-tclass ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: _libssh2-sftp-handle-tclass ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: _libssh2-sftp-statvfs-tclass ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: _libssh2-sftp-tclass ()
Package

libssh2

Source

libssh2-cffi.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: auth-password-emul ()
Package

libssh2

Source

streams.lisp (file)

Direct superclasses

auth-data (class)

Direct methods
Direct slots
Slot: password
Type

string

Initargs

:password

Initform

""

Readers

password (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, libssh2.asd: The libssh2<dot>asd file
File, Lisp, libssh2/src/libssh2-cffi.lisp: The libssh2/src/libssh2-cffi<dot>lisp file
File, Lisp, libssh2/src/libssh2-libc-cffi.lisp: The libssh2/src/libssh2-libc-cffi<dot>lisp file
File, Lisp, libssh2/src/logging.lisp: The libssh2/src/logging<dot>lisp file
File, Lisp, libssh2/src/package.lisp: The libssh2/src/package<dot>lisp file
File, Lisp, libssh2/src/scp.lisp: The libssh2/src/scp<dot>lisp file
File, Lisp, libssh2/src/sftp.lisp: The libssh2/src/sftp<dot>lisp file
File, Lisp, libssh2/src/solutions.lisp: The libssh2/src/solutions<dot>lisp file
File, Lisp, libssh2/src/streams.lisp: The libssh2/src/streams<dot>lisp file
File, Lisp, libssh2/src/types.lisp: The libssh2/src/types<dot>lisp file
File, Lisp, libssh2/src/util.lisp: The libssh2/src/util<dot>lisp file

L
libssh2.asd: The libssh2<dot>asd file
libssh2/src: The libssh2/src module
libssh2/src/libssh2-cffi.lisp: The libssh2/src/libssh2-cffi<dot>lisp file
libssh2/src/libssh2-libc-cffi.lisp: The libssh2/src/libssh2-libc-cffi<dot>lisp file
libssh2/src/logging.lisp: The libssh2/src/logging<dot>lisp file
libssh2/src/package.lisp: The libssh2/src/package<dot>lisp file
libssh2/src/scp.lisp: The libssh2/src/scp<dot>lisp file
libssh2/src/sftp.lisp: The libssh2/src/sftp<dot>lisp file
libssh2/src/solutions.lisp: The libssh2/src/solutions<dot>lisp file
libssh2/src/streams.lisp: The libssh2/src/streams<dot>lisp file
libssh2/src/types.lisp: The libssh2/src/types<dot>lisp file
libssh2/src/util.lisp: The libssh2/src/util<dot>lisp file
Lisp File, libssh2.asd: The libssh2<dot>asd file
Lisp File, libssh2/src/libssh2-cffi.lisp: The libssh2/src/libssh2-cffi<dot>lisp file
Lisp File, libssh2/src/libssh2-libc-cffi.lisp: The libssh2/src/libssh2-libc-cffi<dot>lisp file
Lisp File, libssh2/src/logging.lisp: The libssh2/src/logging<dot>lisp file
Lisp File, libssh2/src/package.lisp: The libssh2/src/package<dot>lisp file
Lisp File, libssh2/src/scp.lisp: The libssh2/src/scp<dot>lisp file
Lisp File, libssh2/src/sftp.lisp: The libssh2/src/sftp<dot>lisp file
Lisp File, libssh2/src/solutions.lisp: The libssh2/src/solutions<dot>lisp file
Lisp File, libssh2/src/streams.lisp: The libssh2/src/streams<dot>lisp file
Lisp File, libssh2/src/types.lisp: The libssh2/src/types<dot>lisp file
Lisp File, libssh2/src/util.lisp: The libssh2/src/util<dot>lisp file

M
Module, libssh2/src: The libssh2/src module

Jump to:   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   H   I   K   L   M   O   P   R   S   T   U   W  
Index Entry  Section

%
%agent-connect: Internal functions
%agent-disconnect: Internal functions
%agent-get-identity: Internal functions
%agent-init: Internal functions
%agent-list-identies: Internal functions
%agent-userauth: Internal functions
%channel-close: Internal functions
%channel-eofp: Internal functions
%channel-flush-ex: Internal functions
%channel-free: Internal functions
%channel-open-ex: Internal functions
%channel-process-startup: Internal functions
%channel-read-ex: Internal functions
%channel-send-eof: Internal functions
%channel-setenv-ex: Internal functions
%channel-wait-closed: Internal functions
%channel-wait-eof: Internal functions
%channel-write-ex: Internal functions
%known-hosts-addc: Internal functions
%known-hosts-check: Internal functions
%known-hosts-checkp: Internal functions
%known-hosts-init: Internal functions
%known-hosts-readfile: Internal functions
%known-hosts-writefile: Internal functions
%library-init: Internal functions
%library-version: Internal functions
%libssh2-sftp-close-handle: Internal functions
%libssh2-sftp-fstat-ex: Internal functions
%libssh2-sftp-fstatvfs: Internal functions
%libssh2-sftp-get-channel: Internal functions
%libssh2-sftp-init: Internal functions
%libssh2-sftp-mkdir-ex: Internal functions
%libssh2-sftp-open-ex: Internal functions
%libssh2-sftp-read: Internal functions
%libssh2-sftp-readdir-ex: Internal functions
%libssh2-sftp-rename-ex: Internal functions
%libssh2-sftp-rmdir-ex: Internal functions
%libssh2-sftp-seek: Internal functions
%libssh2-sftp-seek-64: Internal functions
%libssh2-sftp-shutdown: Internal functions
%libssh2-sftp-stat-ex: Internal functions
%libssh2-sftp-statvfs: Internal functions
%libssh2-sftp-symlink-ex: Internal functions
%libssh2-sftp-tell: Internal functions
%libssh2-sftp-tell-64: Internal functions
%libssh2-sftp-unlink-ex: Internal functions
%libssh2-sftp-write: Internal functions
%scp-recv: Internal functions
%scp-send-ex: Internal functions
%session-auth-methods-list: Internal functions
%session-disconnect: Internal functions
%session-free: Internal functions
%session-handshake: Internal functions
%session-hostkey: Internal functions
%session-last-error: Internal functions
%user-auth-interactive: Internal functions
%user-auth-password: Internal functions
%user-auth-publickey: Internal functions

(
(setf auth-passed): Exported generic functions
(setf auth-passed): Exported generic functions
(setf channel): Exported generic functions
(setf channel): Exported generic functions
(setf code): Exported generic functions
(setf code): Exported generic functions
(setf file): Exported generic functions
(setf file): Exported generic functions
(setf hash): Exported generic functions
(setf hash): Exported generic functions
(setf host): Exported generic functions
(setf host): Exported generic functions
(setf host): Exported generic functions
(setf hosts-db): Exported generic functions
(setf hosts-db): Exported generic functions
(setf input-buffer): Exported generic functions
(setf input-buffer): Exported generic functions
(setf input-pos): Internal generic functions
(setf input-pos): Internal generic functions
(setf input-size): Exported generic functions
(setf input-size): Exported generic functions
(setf message): Exported generic functions
(setf message): Exported generic functions
(setf output-buffer): Exported generic functions
(setf output-buffer): Exported generic functions
(setf output-pos): Exported generic functions
(setf output-pos): Exported generic functions
(setf output-size): Exported generic functions
(setf output-size): Exported generic functions
(setf password): Exported generic functions
(setf password): Exported generic functions
(setf port): Exported generic functions
(setf port): Exported generic functions
(setf private-key): Exported generic functions
(setf private-key): Exported generic functions
(setf public-key): Exported generic functions
(setf public-key): Exported generic functions
(setf reason): Exported generic functions
(setf reason): Exported generic functions
(setf socket): Exported generic functions
(setf socket): Exported generic functions
(setf socket): Exported generic functions

A
agent-connect: Exported functions
agent-disconnect: Exported functions
agent-free: Exported functions
agent-identities-iterator: Exported functions
agent-init: Exported functions
agent-list-identies: Exported functions
auth-passed: Exported generic functions
auth-passed: Exported generic functions
authentication: Exported generic functions
authentication: Exported generic functions
authentication: Exported generic functions
authentication: Exported generic functions
authentication: Exported generic functions
authentication: Exported generic functions
authentication: Exported generic functions
authentication-methods: Exported generic functions
authentication-methods: Exported generic functions

C
channel: Exported generic functions
channel: Exported generic functions
channel-close: Exported functions
channel-eofp: Exported functions
channel-exec: Exported functions
channel-exit-status: Exported functions
channel-flush: Exported functions
channel-free: Exported functions
channel-open: Exported functions
channel-process-start: Exported functions
channel-read: Exported functions
channel-scp-recv: Exported functions
channel-scp-send: Internal functions
channel-send-eof: Exported functions
channel-setenv: Exported functions
channel-shell: Exported functions
channel-subsystem: Exported functions
channel-wait-closed: Exported functions
channel-wait-eof: Internal functions
channel-write: Exported functions
channel-write-string: Exported functions
channel-write-with-conv: Internal macros
code: Exported generic functions
code: Exported generic functions
copy-key: Internal functions
create-ssh-connection: Exported generic functions
create-ssh-connection: Exported generic functions

D
default-config-directory: Internal functions
default-known-hosts: Internal functions
default-private-key: Internal functions
default-public-key: Internal functions
defcfun-error-check: Internal macros
destroy-ssh-connection: Exported generic functions
destroy-ssh-connection: Exported generic functions

E
ends-with-any?: Internal functions
ends-with?: Internal functions
execute: Exported generic functions
execute: Exported generic functions

F
file: Exported generic functions
file: Exported generic functions
foreach-agent-identity: Exported macros
Function, %agent-connect: Internal functions
Function, %agent-disconnect: Internal functions
Function, %agent-get-identity: Internal functions
Function, %agent-init: Internal functions
Function, %agent-list-identies: Internal functions
Function, %agent-userauth: Internal functions
Function, %channel-close: Internal functions
Function, %channel-eofp: Internal functions
Function, %channel-flush-ex: Internal functions
Function, %channel-free: Internal functions
Function, %channel-open-ex: Internal functions
Function, %channel-process-startup: Internal functions
Function, %channel-read-ex: Internal functions
Function, %channel-send-eof: Internal functions
Function, %channel-setenv-ex: Internal functions
Function, %channel-wait-closed: Internal functions
Function, %channel-wait-eof: Internal functions
Function, %channel-write-ex: Internal functions
Function, %known-hosts-addc: Internal functions
Function, %known-hosts-check: Internal functions
Function, %known-hosts-checkp: Internal functions
Function, %known-hosts-init: Internal functions
Function, %known-hosts-readfile: Internal functions
Function, %known-hosts-writefile: Internal functions
Function, %library-init: Internal functions
Function, %library-version: Internal functions
Function, %libssh2-sftp-close-handle: Internal functions
Function, %libssh2-sftp-fstat-ex: Internal functions
Function, %libssh2-sftp-fstatvfs: Internal functions
Function, %libssh2-sftp-get-channel: Internal functions
Function, %libssh2-sftp-init: Internal functions
Function, %libssh2-sftp-mkdir-ex: Internal functions
Function, %libssh2-sftp-open-ex: Internal functions
Function, %libssh2-sftp-read: Internal functions
Function, %libssh2-sftp-readdir-ex: Internal functions
Function, %libssh2-sftp-rename-ex: Internal functions
Function, %libssh2-sftp-rmdir-ex: Internal functions
Function, %libssh2-sftp-seek: Internal functions
Function, %libssh2-sftp-seek-64: Internal functions
Function, %libssh2-sftp-shutdown: Internal functions
Function, %libssh2-sftp-stat-ex: Internal functions
Function, %libssh2-sftp-statvfs: Internal functions
Function, %libssh2-sftp-symlink-ex: Internal functions
Function, %libssh2-sftp-tell: Internal functions
Function, %libssh2-sftp-tell-64: Internal functions
Function, %libssh2-sftp-unlink-ex: Internal functions
Function, %libssh2-sftp-write: Internal functions
Function, %scp-recv: Internal functions
Function, %scp-send-ex: Internal functions
Function, %session-auth-methods-list: Internal functions
Function, %session-disconnect: Internal functions
Function, %session-free: Internal functions
Function, %session-handshake: Internal functions
Function, %session-hostkey: Internal functions
Function, %session-last-error: Internal functions
Function, %user-auth-interactive: Internal functions
Function, %user-auth-password: Internal functions
Function, %user-auth-publickey: Internal functions
Function, agent-connect: Exported functions
Function, agent-disconnect: Exported functions
Function, agent-free: Exported functions
Function, agent-identities-iterator: Exported functions
Function, agent-init: Exported functions
Function, agent-list-identies: Exported functions
Function, channel-close: Exported functions
Function, channel-eofp: Exported functions
Function, channel-exec: Exported functions
Function, channel-exit-status: Exported functions
Function, channel-flush: Exported functions
Function, channel-free: Exported functions
Function, channel-open: Exported functions
Function, channel-process-start: Exported functions
Function, channel-read: Exported functions
Function, channel-scp-recv: Exported functions
Function, channel-scp-send: Internal functions
Function, channel-send-eof: Exported functions
Function, channel-setenv: Exported functions
Function, channel-shell: Exported functions
Function, channel-subsystem: Exported functions
Function, channel-wait-closed: Exported functions
Function, channel-wait-eof: Internal functions
Function, channel-write: Exported functions
Function, channel-write-string: Exported functions
Function, copy-key: Internal functions
Function, default-config-directory: Internal functions
Function, default-known-hosts: Internal functions
Function, default-private-key: Internal functions
Function, default-public-key: Internal functions
Function, ends-with-any?: Internal functions
Function, ends-with?: Internal functions
Function, get-universal-unix-time: Internal functions
Function, key-data: Internal functions
Function, key-p: Internal functions
Function, key-size: Internal functions
Function, key-type: Internal functions
Function, known-hosts-add: Exported functions
Function, known-hosts-check: Exported functions
Function, known-hosts-free: Exported functions
Function, known-hosts-init: Exported functions
Function, known-hosts-readfile: Exported functions
Function, known-hosts-writefile: Exported functions
Function, library-exit: Internal functions
Function, library-init: Internal functions
Function, library-trace: Internal functions
Function, libssh2-sftp-close-handle: Internal functions
Function, libssh2-sftp-fstat-ex: Internal functions
Function, libssh2-sftp-fstatvfs: Internal functions
Function, libssh2-sftp-get-channel: Internal functions
Function, libssh2-sftp-init: Internal functions
Function, libssh2-sftp-last-error: Internal functions
Function, libssh2-sftp-mkdir-ex: Internal functions
Function, libssh2-sftp-open-ex: Internal functions
Function, libssh2-sftp-read: Internal functions
Function, libssh2-sftp-readdir-ex: Internal functions
Function, libssh2-sftp-rename-ex: Internal functions
Function, libssh2-sftp-rmdir-ex: Internal functions
Function, libssh2-sftp-seek: Internal functions
Function, libssh2-sftp-seek-64: Internal functions
Function, libssh2-sftp-shutdown: Internal functions
Function, libssh2-sftp-stat-ex: Internal functions
Function, libssh2-sftp-statvfs: Internal functions
Function, libssh2-sftp-symlink-ex: Internal functions
Function, libssh2-sftp-tell: Internal functions
Function, libssh2-sftp-tell-64: Internal functions
Function, libssh2-sftp-unlink-ex: Internal functions
Function, libssh2-sftp-write: Internal functions
Function, make-agent-auth: Exported functions
Function, make-auth-data: Exported functions
Function, make-key: Internal functions
Function, make-password-auth: Exported functions
Function, make-password-emul-auth: Exported functions
Function, make-publickey-auth: Exported functions
Function, print-memory: Internal functions
Function, scp-get: Exported functions
Function, scp-put: Exported functions
Function, session-auth-methods-list: Exported functions
Function, session-disconnect: Exported functions
Function, session-free: Internal functions
Function, session-handshake: Exported functions
Function, session-hostkey: Exported functions
Function, session-hostkey-fingerprint: Exported functions
Function, session-hostkey-hash: Internal functions
Function, session-init: Exported functions
Function, session-init-ex: Internal functions
Function, session-last-errno: Internal functions
Function, session-last-error: Exported functions
Function, session-set-blocking: Internal functions
Function, set-timeouts: Internal functions
Function, sftp-delete: Internal functions
Function, sftp-get: Internal functions
Function, sftp-list-directory: Exported functions
Function, throw-last-error: Internal functions
Function, user-auth-agent: Exported functions
Function, user-auth-interactive: Internal functions
Function, user-auth-interactive-trivial: Internal functions
Function, user-auth-password: Exported functions
Function, user-auth-publickey: Exported functions
Function, usocket-get-fd: Internal functions

G
Generic Function, (setf auth-passed): Exported generic functions
Generic Function, (setf channel): Exported generic functions
Generic Function, (setf code): Exported generic functions
Generic Function, (setf file): Exported generic functions
Generic Function, (setf hash): Exported generic functions
Generic Function, (setf host): Exported generic functions
Generic Function, (setf hosts-db): Exported generic functions
Generic Function, (setf input-buffer): Exported generic functions
Generic Function, (setf input-pos): Internal generic functions
Generic Function, (setf input-size): Exported generic functions
Generic Function, (setf message): Exported generic functions
Generic Function, (setf output-buffer): Exported generic functions
Generic Function, (setf output-pos): Exported generic functions
Generic Function, (setf output-size): Exported generic functions
Generic Function, (setf password): Exported generic functions
Generic Function, (setf port): Exported generic functions
Generic Function, (setf private-key): Exported generic functions
Generic Function, (setf public-key): Exported generic functions
Generic Function, (setf reason): Exported generic functions
Generic Function, (setf socket): Exported generic functions
Generic Function, auth-passed: Exported generic functions
Generic Function, authentication: Exported generic functions
Generic Function, authentication-methods: Exported generic functions
Generic Function, channel: Exported generic functions
Generic Function, code: Exported generic functions
Generic Function, create-ssh-connection: Exported generic functions
Generic Function, destroy-ssh-connection: Exported generic functions
Generic Function, execute: Exported generic functions
Generic Function, file: Exported generic functions
Generic Function, hash: Exported generic functions
Generic Function, host: Exported generic functions
Generic Function, hosts-db: Exported generic functions
Generic Function, input-buffer: Exported generic functions
Generic Function, input-pos: Internal generic functions
Generic Function, input-size: Exported generic functions
Generic Function, login: Internal generic functions
Generic Function, message: Exported generic functions
Generic Function, method-of: Internal generic functions
Generic Function, output-buffer: Exported generic functions
Generic Function, output-pos: Exported generic functions
Generic Function, output-size: Exported generic functions
Generic Function, password: Exported generic functions
Generic Function, port: Exported generic functions
Generic Function, private-key: Exported generic functions
Generic Function, public-key: Exported generic functions
Generic Function, reason: Exported generic functions
Generic Function, scp-input: Exported generic functions
Generic Function, scp-output: Exported generic functions
Generic Function, session: Exported generic functions
Generic Function, socket: Exported generic functions
Generic Function, ssh-host+port-format: Internal generic functions
Generic Function, ssh-session-key: Exported generic functions
Generic Function, ssh-verify-session: Exported generic functions
Generic Function, stream-finish-output*: Exported generic functions
get-universal-unix-time: Internal functions

H
hash: Exported generic functions
hash: Exported generic functions
host: Exported generic functions
host: Exported generic functions
host: Exported generic functions
hosts-db: Exported generic functions
hosts-db: Exported generic functions

I
input-buffer: Exported generic functions
input-buffer: Exported generic functions
input-pos: Internal generic functions
input-pos: Internal generic functions
input-size: Exported generic functions
input-size: Exported generic functions

K
key-data: Internal functions
key-p: Internal functions
key-size: Internal functions
key-type: Internal functions
known-hosts-add: Exported functions
known-hosts-check: Exported functions
known-hosts-free: Exported functions
known-hosts-init: Exported functions
known-hosts-readfile: Exported functions
known-hosts-writefile: Exported functions

L
library-exit: Internal functions
library-init: Internal functions
library-trace: Internal functions
libssh2-sftp-close-handle: Internal functions
libssh2-sftp-fstat-ex: Internal functions
libssh2-sftp-fstatvfs: Internal functions
libssh2-sftp-get-channel: Internal functions
libssh2-sftp-init: Internal functions
libssh2-sftp-last-error: Internal functions
libssh2-sftp-mkdir-ex: Internal functions
libssh2-sftp-open-ex: Internal functions
libssh2-sftp-read: Internal functions
libssh2-sftp-readdir-ex: Internal functions
libssh2-sftp-rename-ex: Internal functions
libssh2-sftp-rmdir-ex: Internal functions
libssh2-sftp-seek: Internal functions
libssh2-sftp-seek-64: Internal functions
libssh2-sftp-shutdown: Internal functions
libssh2-sftp-stat-ex: Internal functions
libssh2-sftp-statvfs: Internal functions
libssh2-sftp-symlink-ex: Internal functions
libssh2-sftp-tell: Internal functions
libssh2-sftp-tell-64: Internal functions
libssh2-sftp-unlink-ex: Internal functions
libssh2-sftp-write: Internal functions
login: Internal generic functions
login: Internal generic functions

M
Macro, channel-write-with-conv: Internal macros
Macro, defcfun-error-check: Internal macros
Macro, foreach-agent-identity: Exported macros
Macro, result-or-error: Internal macros
Macro, ssh2.debug: Internal macros
Macro, ssh2.dribble: Internal macros
Macro, ssh2.error: Internal macros
Macro, ssh2.fatal: Internal macros
Macro, ssh2.info: Internal macros
Macro, ssh2.warn: Internal macros
Macro, with-agent: Exported macros
Macro, with-execute: Exported macros
Macro, with-execute*: Exported macros
Macro, with-known-hosts: Exported macros
Macro, with-last-error: Internal macros
Macro, with-scp-input: Exported macros
Macro, with-scp-output: Exported macros
Macro, with-session: Exported macros
Macro, with-sftp: Internal macros
Macro, with-ssh-connection: Exported macros
make-agent-auth: Exported functions
make-auth-data: Exported functions
make-key: Internal functions
make-password-auth: Exported functions
make-password-emul-auth: Exported functions
make-publickey-auth: Exported functions
message: Exported generic functions
message: Exported generic functions
Method, (setf auth-passed): Exported generic functions
Method, (setf channel): Exported generic functions
Method, (setf code): Exported generic functions
Method, (setf file): Exported generic functions
Method, (setf hash): Exported generic functions
Method, (setf host): Exported generic functions
Method, (setf host): Exported generic functions
Method, (setf hosts-db): Exported generic functions
Method, (setf input-buffer): Exported generic functions
Method, (setf input-pos): Internal generic functions
Method, (setf input-size): Exported generic functions
Method, (setf message): Exported generic functions
Method, (setf output-buffer): Exported generic functions
Method, (setf output-pos): Exported generic functions
Method, (setf output-size): Exported generic functions
Method, (setf password): Exported generic functions
Method, (setf port): Exported generic functions
Method, (setf private-key): Exported generic functions
Method, (setf public-key): Exported generic functions
Method, (setf reason): Exported generic functions
Method, (setf socket): Exported generic functions
Method, (setf socket): Exported generic functions
Method, auth-passed: Exported generic functions
Method, authentication: Exported generic functions
Method, authentication: Exported generic functions
Method, authentication: Exported generic functions
Method, authentication: Exported generic functions
Method, authentication: Exported generic functions
Method, authentication: Exported generic functions
Method, authentication-methods: Exported generic functions
Method, channel: Exported generic functions
Method, code: Exported generic functions
Method, create-ssh-connection: Exported generic functions
Method, destroy-ssh-connection: Exported generic functions
Method, execute: Exported generic functions
Method, file: Exported generic functions
Method, hash: Exported generic functions
Method, host: Exported generic functions
Method, host: Exported generic functions
Method, hosts-db: Exported generic functions
Method, input-buffer: Exported generic functions
Method, input-pos: Internal generic functions
Method, input-size: Exported generic functions
Method, login: Internal generic functions
Method, message: Exported generic functions
Method, method-of: Internal generic functions
Method, method-of: Internal generic functions
Method, method-of: Internal generic functions
Method, output-buffer: Exported generic functions
Method, output-pos: Exported generic functions
Method, output-size: Exported generic functions
Method, password: Exported generic functions
Method, password: Exported generic functions
Method, password: Exported generic functions
Method, port: Exported generic functions
Method, private-key: Exported generic functions
Method, public-key: Exported generic functions
Method, reason: Exported generic functions
Method, scp-input: Exported generic functions
Method, scp-output: Exported generic functions
Method, session: Exported generic functions
Method, socket: Exported generic functions
Method, socket: Exported generic functions
Method, ssh-host+port-format: Internal generic functions
Method, ssh-session-key: Exported generic functions
Method, ssh-verify-session: Exported generic functions
Method, stream-finish-output*: Exported generic functions
method-of: Internal generic functions
method-of: Internal generic functions
method-of: Internal generic functions
method-of: Internal generic functions

O
output-buffer: Exported generic functions
output-buffer: Exported generic functions
output-pos: Exported generic functions
output-pos: Exported generic functions
output-size: Exported generic functions
output-size: Exported generic functions

P
password: Exported generic functions
password: Exported generic functions
password: Exported generic functions
password: Exported generic functions
port: Exported generic functions
port: Exported generic functions
print-memory: Internal functions
private-key: Exported generic functions
private-key: Exported generic functions
public-key: Exported generic functions
public-key: Exported generic functions

R
reason: Exported generic functions
reason: Exported generic functions
result-or-error: Internal macros

S
scp-get: Exported functions
scp-input: Exported generic functions
scp-input: Exported generic functions
scp-output: Exported generic functions
scp-output: Exported generic functions
scp-put: Exported functions
session: Exported generic functions
session: Exported generic functions
session-auth-methods-list: Exported functions
session-disconnect: Exported functions
session-free: Internal functions
session-handshake: Exported functions
session-hostkey: Exported functions
session-hostkey-fingerprint: Exported functions
session-hostkey-hash: Internal functions
session-init: Exported functions
session-init-ex: Internal functions
session-last-errno: Internal functions
session-last-error: Exported functions
session-set-blocking: Internal functions
set-timeouts: Internal functions
sftp-delete: Internal functions
sftp-get: Internal functions
sftp-list-directory: Exported functions
socket: Exported generic functions
socket: Exported generic functions
socket: Exported generic functions
ssh-host+port-format: Internal generic functions
ssh-host+port-format: Internal generic functions
ssh-session-key: Exported generic functions
ssh-session-key: Exported generic functions
ssh-verify-session: Exported generic functions
ssh-verify-session: Exported generic functions
ssh2.debug: Internal macros
ssh2.dribble: Internal macros
ssh2.error: Internal macros
ssh2.fatal: Internal macros
ssh2.info: Internal macros
ssh2.warn: Internal macros
stream-finish-output*: Exported generic functions
stream-finish-output*: Exported generic functions

T
throw-last-error: Internal functions

U
user-auth-agent: Exported functions
user-auth-interactive: Internal functions
user-auth-interactive-trivial: Internal functions
user-auth-password: Exported functions
user-auth-publickey: Exported functions
usocket-get-fd: Internal functions

W
with-agent: Exported macros
with-execute: Exported macros
with-execute*: Exported macros
with-known-hosts: Exported macros
with-last-error: Internal macros
with-scp-input: Exported macros
with-scp-output: Exported macros
with-session: Exported macros
with-sftp: Internal macros
with-ssh-connection: Exported macros

Jump to:   %   (  
A   C   D   E   F   G   H   I   K   L   M   O   P   R   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +   .  
A   C   D   F   H   I   L   M   O   P   R   S   T  
Index Entry  Section

*
*channel-read-type*: Exported special variables
*channel-read-zero-as-eof*: Exported special variables
*config-directory*: Internal special variables
*default-errors-list*: Exported special variables
*errors-list*: Exported special variables
*keyboard-interactive-password*: Internal special variables
*session*: Internal special variables
*sftp-session*: Internal special variables
*ssh-channel-buffer-size*: Internal special variables
*ssh-connection*: Internal special variables

+
+sftp-read-buffer-size+: Internal constants

.
.auth.: Internal constants
.base64.: Internal constants
.conn.: Internal constants
.error.: Internal constants
.kex.: Internal constants
.publickey: Internal constants
.raw.: Internal constants
.rsa1.: Internal constants
.scp.: Internal constants
.sftp.: Internal constants
.socket: Internal constants
.ssh.: Internal constants
.trans.: Internal constants
.type-plain.: Internal constants
.type-sha1.: Internal constants

A
auth-passed: Exported classes

C
channel: Exported classes
code: Internal conditions
Constant, +sftp-read-buffer-size+: Internal constants
Constant, .auth.: Internal constants
Constant, .base64.: Internal constants
Constant, .conn.: Internal constants
Constant, .error.: Internal constants
Constant, .kex.: Internal constants
Constant, .publickey: Internal constants
Constant, .raw.: Internal constants
Constant, .rsa1.: Internal constants
Constant, .scp.: Internal constants
Constant, .sftp.: Internal constants
Constant, .socket: Internal constants
Constant, .ssh.: Internal constants
Constant, .trans.: Internal constants
Constant, .type-plain.: Internal constants
Constant, .type-sha1.: Internal constants
Constant, size-of-+stat+: Internal constants

D
data: Exported structures

F
file: Exported conditions

H
hash: Internal conditions
host: Exported classes
host: Internal conditions
hosts-db: Exported classes

I
input-buffer: Exported classes
input-pos: Exported classes
input-size: Exported classes

L
login: Exported classes

M
message: Internal conditions

O
output-buffer: Exported classes
output-pos: Exported classes
output-size: Exported classes

P
password: Exported classes
password: Exported classes
password: Internal classes
port: Exported classes
private-key: Exported classes
public-key: Exported classes

R
reason: Exported conditions

S
session: Exported classes
size: Exported structures
size-of-+stat+: Internal constants
Slot, auth-passed: Exported classes
Slot, channel: Exported classes
Slot, code: Internal conditions
Slot, data: Exported structures
Slot, file: Exported conditions
Slot, hash: Internal conditions
Slot, host: Exported classes
Slot, host: Internal conditions
Slot, hosts-db: Exported classes
Slot, input-buffer: Exported classes
Slot, input-pos: Exported classes
Slot, input-size: Exported classes
Slot, login: Exported classes
Slot, message: Internal conditions
Slot, output-buffer: Exported classes
Slot, output-pos: Exported classes
Slot, output-size: Exported classes
Slot, password: Exported classes
Slot, password: Exported classes
Slot, password: Internal classes
Slot, port: Exported classes
Slot, private-key: Exported classes
Slot, public-key: Exported classes
Slot, reason: Exported conditions
Slot, session: Exported classes
Slot, size: Exported structures
Slot, socket: Exported classes
Slot, socket: Exported classes
Slot, type: Exported structures
socket: Exported classes
socket: Exported classes
Special Variable, *channel-read-type*: Exported special variables
Special Variable, *channel-read-zero-as-eof*: Exported special variables
Special Variable, *config-directory*: Internal special variables
Special Variable, *default-errors-list*: Exported special variables
Special Variable, *errors-list*: Exported special variables
Special Variable, *keyboard-interactive-password*: Internal special variables
Special Variable, *session*: Internal special variables
Special Variable, *sftp-session*: Internal special variables
Special Variable, *ssh-channel-buffer-size*: Internal special variables
Special Variable, *ssh-connection*: Internal special variables

T
type: Exported structures

Jump to:   *   +   .  
A   C   D   F   H   I   L   M   O   P   R   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   +   _  
A   C   K   L   P   S  
Index Entry  Section

+
+kbd-prompt+-tclass: Internal classes
+kbd-response+-tclass: Internal classes
+known-host+-tclass: Internal classes
+stat+-tclass: Internal classes

_
_libssh2-sftp-attributes-tclass: Internal classes
_libssh2-sftp-handle-tclass: Internal classes
_libssh2-sftp-statvfs-tclass: Internal classes
_libssh2-sftp-tclass: Internal classes

A
auth-agent: Exported classes
auth-data: Exported classes
auth-password: Exported classes
auth-password-emul: Internal classes
auth-publickey: Exported classes

C
Class, +kbd-prompt+-tclass: Internal classes
Class, +kbd-response+-tclass: Internal classes
Class, +known-host+-tclass: Internal classes
Class, +stat+-tclass: Internal classes
Class, auth-agent: Exported classes
Class, auth-data: Exported classes
Class, auth-password: Exported classes
Class, auth-password-emul: Internal classes
Class, auth-publickey: Exported classes
Class, ssh-channel-exec: Exported classes
Class, ssh-channel-recv: Exported classes
Class, ssh-channel-send: Exported classes
Class, ssh-channel-stream: Exported classes
Class, ssh-channel-stream-input: Exported classes
Class, ssh-channel-stream-input/output: Exported classes
Class, ssh-channel-stream-output: Exported classes
Class, ssh-connection: Exported classes
Class, _libssh2-sftp-attributes-tclass: Internal classes
Class, _libssh2-sftp-handle-tclass: Internal classes
Class, _libssh2-sftp-statvfs-tclass: Internal classes
Class, _libssh2-sftp-tclass: Internal classes
Condition, known-hosts-reading-error: Exported conditions
Condition, libssh2-invalid-error-code: Internal conditions
Condition, ssh-authentication-failure: Internal conditions
Condition, ssh-bad-hostkey: Exported conditions
Condition, ssh-condition: Internal conditions
Condition, ssh-generic-error: Exported conditions
Condition, ssh-handshake-error: Exported conditions
Condition, ssh-hostkey-condition: Internal conditions
Condition, ssh-unknown-hostkey: Internal conditions

K
key: Exported structures
known-hosts-reading-error: Exported conditions

L
libssh2: The libssh2 system
libssh2: The libssh2 package
libssh2-invalid-error-code: Internal conditions

P
Package, libssh2: The libssh2 package

S
ssh-authentication-failure: Internal conditions
ssh-bad-hostkey: Exported conditions
ssh-channel-exec: Exported classes
ssh-channel-recv: Exported classes
ssh-channel-send: Exported classes
ssh-channel-stream: Exported classes
ssh-channel-stream-input: Exported classes
ssh-channel-stream-input/output: Exported classes
ssh-channel-stream-output: Exported classes
ssh-condition: Internal conditions
ssh-connection: Exported classes
ssh-generic-error: Exported conditions
ssh-handshake-error: Exported conditions
ssh-hostkey-condition: Internal conditions
ssh-unknown-hostkey: Internal conditions
Structure, key: Exported structures
System, libssh2: The libssh2 system

Jump to:   +   _  
A   C   K   L   P   S