This is the libssh2 Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 11:53:35 2026 GMT+0.
libssh2/libssh2.asdlibssh2/src/package.lisplibssh2/src/logging.lisplibssh2/src/types.lisplibssh2/src/libssh2-libc-cffi.lisplibssh2/src/util.lisplibssh2/src/libssh2-cffi.lisplibssh2/src/streams.lisplibssh2/src/scp.lisplibssh2/src/sftp.lisplibssh2/src/solutions.lispThe main system appears first, followed by any subsystem dependency.
libssh2Trivial libssh2 bindings
Oleksii Shevchuk <alxchk@gmail.com>
Public Domain
0.1
babel (system).
cffi (system).
cl-fad (system).
hu.dwim.logger (system).
split-sequence (system).
trivial-gray-streams (system).
usocket (system).
src (module).
Modules are listed depth-first from the system components tree.
libssh2/srclibssh2 (system).
package.lisp (file).
logging.lisp (file).
types.lisp (file).
libssh2-libc-cffi.lisp (file).
util.lisp (file).
libssh2-cffi.lisp (file).
streams.lisp (file).
scp.lisp (file).
sftp.lisp (file).
solutions.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
libssh2/libssh2.asdlibssh2/src/package.lisplibssh2/src/logging.lisplibssh2/src/types.lisplibssh2/src/libssh2-libc-cffi.lisplibssh2/src/util.lisplibssh2/src/libssh2-cffi.lisplibssh2/src/streams.lisplibssh2/src/scp.lisplibssh2/src/sftp.lisplibssh2/src/solutions.lisplibssh2/src/logging.lisppackage.lisp (file).
src (module).
ssh2.debug (macro).
ssh2.dribble (macro).
ssh2.error (macro).
ssh2.fatal (macro).
ssh2.info (macro).
ssh2.warn (macro).
libssh2/src/types.lisplogging.lisp (file).
src (module).
*default-errors-list* (special variable).
*errors-list* (special variable).
code (reader method).
(setf code) (writer method).
hash (reader method).
(setf hash) (writer method).
host (reader method).
(setf host) (writer method).
initialize-instance (method).
key (structure).
message (reader method).
(setf message) (writer method).
reason (reader method).
(setf reason) (writer method).
ssh-bad-hostkey (condition).
ssh-generic-error (condition).
ssh-handshake-error (condition).
+kbd-prompt+-tclass (class).
+kbd-response+-tclass (class).
+known-host+-tclass (class).
.auth. (constant).
.base64. (constant).
.conn. (constant).
.error. (constant).
.kex. (constant).
.publickey (constant).
.raw. (constant).
.rsa1. (constant).
.scp. (constant).
.sftp. (constant).
.socket (constant).
.ssh. (constant).
.trans. (constant).
.type-plain. (constant).
.type-sha1. (constant).
copy-key (function).
key-data (reader).
key-p (function).
key-size (reader).
key-type (reader).
libssh2-invalid-error-code (condition).
make-key (function).
ssh-condition (condition).
ssh-hostkey-condition (condition).
ssh-unknown-hostkey (condition).
libssh2/src/libssh2-libc-cffi.lisptypes.lisp (file).
src (module).
libssh2/src/util.lisplibssh2-libc-cffi.lisp (file).
src (module).
*config-directory* (special variable).
default-config-directory (function).
default-known-hosts (function).
default-private-key (function).
default-public-key (function).
set-timeouts (function).
usocket-get-fd (function).
libssh2/src/libssh2-cffi.lisputil.lisp (file).
src (module).
*channel-read-type* (special variable).
*channel-read-zero-as-eof* (special variable).
agent-connect (function).
agent-disconnect (function).
agent-free (function).
agent-identities-iterator (function).
agent-init (function).
agent-list-identies (function).
channel-close (function).
channel-eofp (function).
channel-exec (function).
channel-exit-status (function).
channel-flush (function).
channel-free (function).
channel-open (function).
channel-process-start (function).
channel-read (function).
channel-scp-recv (function).
channel-send-eof (function).
channel-setenv (function).
channel-shell (function).
channel-subsystem (function).
channel-wait-closed (function).
channel-write (function).
channel-write-string (function).
file (reader method).
(setf file) (writer method).
foreach-agent-identity (macro).
known-hosts-add (function).
known-hosts-check (function).
known-hosts-free (function).
known-hosts-init (function).
known-hosts-readfile (function).
known-hosts-reading-error (condition).
known-hosts-writefile (function).
print-object (method).
session-auth-methods-list (function).
session-disconnect (function).
session-handshake (function).
session-hostkey (function).
session-hostkey-fingerprint (function).
session-init (function).
session-last-error (function).
user-auth-agent (function).
user-auth-password (function).
user-auth-publickey (function).
with-agent (macro).
with-known-hosts (macro).
with-session (macro).
%agent-connect (function).
%agent-disconnect (function).
%agent-get-identity (function).
%agent-init (function).
%agent-list-identies (function).
%agent-userauth (function).
%channel-close (function).
%channel-eofp (function).
%channel-flush-ex (function).
%channel-free (function).
%channel-open-ex (function).
%channel-process-startup (function).
%channel-read-ex (function).
%channel-send-eof (function).
%channel-setenv-ex (function).
%channel-wait-closed (function).
%channel-wait-eof (function).
%channel-write-ex (function).
%known-hosts-addc (function).
%known-hosts-check (function).
%known-hosts-checkp (function).
%known-hosts-init (function).
%known-hosts-readfile (function).
%known-hosts-writefile (function).
%library-init (function).
%library-version (function).
%libssh2-sftp-close-handle (function).
%libssh2-sftp-fstat-ex (function).
%libssh2-sftp-fstatvfs (function).
%libssh2-sftp-get-channel (function).
%libssh2-sftp-init (function).
%libssh2-sftp-mkdir-ex (function).
%libssh2-sftp-open-ex (function).
%libssh2-sftp-read (function).
%libssh2-sftp-readdir-ex (function).
%libssh2-sftp-rename-ex (function).
%libssh2-sftp-rmdir-ex (function).
%libssh2-sftp-seek (function).
%libssh2-sftp-seek-64 (function).
%libssh2-sftp-shutdown (function).
%libssh2-sftp-stat-ex (function).
%libssh2-sftp-statvfs (function).
%libssh2-sftp-symlink-ex (function).
%libssh2-sftp-tell (function).
%libssh2-sftp-tell-64 (function).
%libssh2-sftp-unlink-ex (function).
%libssh2-sftp-write (function).
%scp-recv (function).
%scp-send-ex (function).
%session-auth-methods-list (function).
%session-disconnect (function).
%session-free (function).
%session-handshake (function).
%session-hostkey (function).
%session-last-error (function).
%user-auth-interactive (function).
%user-auth-password (function).
%user-auth-publickey (function).
*keyboard-interactive-password* (special variable).
*sftp-session* (special variable).
*ssh-connection* (special variable).
_libssh2-sftp-attributes-tclass (class).
_libssh2-sftp-handle-tclass (class).
_libssh2-sftp-statvfs-tclass (class).
_libssh2-sftp-tclass (class).
channel-scp-send (function).
channel-wait-eof (function).
channel-write-with-conv (macro).
defcfun-error-check (macro).
get-universal-unix-time (function).
library-exit (function).
library-init (function).
library-trace (function).
libssh2-sftp-close-handle (function).
libssh2-sftp-fstat-ex (function).
libssh2-sftp-fstatvfs (function).
libssh2-sftp-get-channel (function).
libssh2-sftp-init (function).
libssh2-sftp-last-error (function).
libssh2-sftp-mkdir-ex (function).
libssh2-sftp-open-ex (function).
libssh2-sftp-read (function).
libssh2-sftp-readdir-ex (function).
libssh2-sftp-rename-ex (function).
libssh2-sftp-rmdir-ex (function).
libssh2-sftp-seek (function).
libssh2-sftp-seek-64 (function).
libssh2-sftp-shutdown (function).
libssh2-sftp-stat-ex (function).
libssh2-sftp-statvfs (function).
libssh2-sftp-symlink-ex (function).
libssh2-sftp-tell (function).
libssh2-sftp-tell-64 (function).
libssh2-sftp-unlink-ex (function).
libssh2-sftp-write (function).
print-memory (function).
result-or-error (macro).
session-free (function).
session-hostkey-hash (function).
session-init-ex (function).
session-last-errno (function).
session-set-blocking (function).
user-auth-interactive (function).
user-auth-interactive-trivial (function).
libssh2/src/streams.lisplibssh2-cffi.lisp (file).
src (module).
auth-agent (class).
auth-data (class).
auth-passed (reader method).
(setf auth-passed) (writer method).
auth-password (class).
auth-publickey (class).
authentication (method).
authentication (method).
authentication (method).
authentication (method).
authentication (method).
authentication-methods (method).
channel (reader method).
(setf channel) (writer method).
close (method).
create-ssh-connection (method).
destroy-ssh-connection (method).
execute (method).
host (reader method).
(setf host) (writer method).
hosts-db (reader method).
(setf hosts-db) (writer method).
input-buffer (reader method).
(setf input-buffer) (writer method).
input-size (reader method).
(setf input-size) (writer method).
make-agent-auth (function).
make-password-auth (function).
make-password-emul-auth (function).
make-publickey-auth (function).
open-stream-p (method).
output-buffer (reader method).
(setf output-buffer) (writer method).
output-pos (reader method).
(setf output-pos) (writer method).
output-size (reader method).
(setf output-size) (writer method).
password (reader method).
password (reader method).
password (reader method).
(setf password) (writer method).
port (reader method).
(setf port) (writer method).
private-key (reader method).
(setf private-key) (writer method).
public-key (reader method).
(setf public-key) (writer method).
scp-input (method).
scp-output (method).
session (reader method).
socket (reader method).
socket (reader method).
(setf socket) (writer method).
(setf socket) (writer method).
ssh-channel-exec (class).
ssh-channel-recv (class).
ssh-channel-send (class).
ssh-channel-stream (class).
ssh-channel-stream-input (class).
ssh-channel-stream-input/output (class).
ssh-channel-stream-output (class).
ssh-connection (class).
ssh-session-key (method).
ssh-verify-session (method).
stream-element-type (method).
stream-finish-output (method).
stream-finish-output (method).
stream-finish-output* (method).
stream-force-output (method).
stream-force-output (method).
stream-listen (method).
stream-read-byte (method).
stream-read-line (method).
stream-read-sequence (method).
stream-read-sequence (method).
stream-write-byte (method).
stream-write-char (method).
stream-write-sequence (method).
stream-write-sequence (method).
with-execute (macro).
with-execute* (macro).
with-scp-input (macro).
with-scp-output (macro).
with-ssh-connection (macro).
*ssh-channel-buffer-size* (special variable).
auth-password-emul (class).
input-pos (reader method).
(setf input-pos) (writer method).
login (reader method).
ssh-authentication-failure (condition).
ssh-host+port-format (method).
throw-last-error (function).
with-last-error (macro).
libssh2/src/scp.lispstreams.lisp (file).
src (module).
libssh2/src/sftp.lispscp.lisp (file).
src (module).
sftp-list-directory (function).
+sftp-read-buffer-size+ (constant).
ends-with-any? (function).
ends-with? (function).
sftp-delete (function).
sftp-get (function).
with-sftp (macro).
libssh2/src/solutions.lispsftp.lisp (file).
src (module).
authentication (method).
make-auth-data (function).
Packages are listed by definition order.
libssh2cffi.
common-lisp.
trivial-gray-streams.
*channel-read-type* (special variable).
*channel-read-zero-as-eof* (special variable).
*default-errors-list* (special variable).
*errors-list* (special variable).
agent-connect (function).
agent-disconnect (function).
agent-free (function).
agent-identities-iterator (function).
agent-init (function).
agent-list-identies (function).
auth-agent (class).
auth-data (class).
auth-passed (generic reader).
(setf auth-passed) (generic writer).
auth-password (class).
auth-publickey (class).
authentication (generic function).
authentication-methods (generic function).
channel (generic reader).
(setf channel) (generic writer).
channel-close (function).
channel-eofp (function).
channel-exec (function).
channel-exit-status (function).
channel-flush (function).
channel-free (function).
channel-open (function).
channel-process-start (function).
channel-read (function).
channel-scp-recv (function).
channel-send-eof (function).
channel-setenv (function).
channel-shell (function).
channel-subsystem (function).
channel-wait-closed (function).
channel-write (function).
channel-write-string (function).
code (generic reader).
(setf code) (generic writer).
create-ssh-connection (generic function).
destroy-ssh-connection (generic function).
execute (generic function).
file (generic reader).
(setf file) (generic writer).
foreach-agent-identity (macro).
hash (generic reader).
(setf hash) (generic writer).
host (generic reader).
(setf host) (generic writer).
hosts-db (generic reader).
(setf hosts-db) (generic writer).
input-buffer (generic reader).
(setf input-buffer) (generic writer).
input-size (generic reader).
(setf input-size) (generic writer).
key (structure).
known-hosts-add (function).
known-hosts-check (function).
known-hosts-free (function).
known-hosts-init (function).
known-hosts-readfile (function).
known-hosts-reading-error (condition).
known-hosts-writefile (function).
make-agent-auth (function).
make-auth-data (function).
make-password-auth (function).
make-password-emul-auth (function).
make-publickey-auth (function).
message (generic reader).
(setf message) (generic writer).
output-buffer (generic reader).
(setf output-buffer) (generic writer).
output-pos (generic reader).
(setf output-pos) (generic writer).
output-size (generic reader).
(setf output-size) (generic writer).
password (generic reader).
(setf password) (generic writer).
port (generic reader).
(setf port) (generic writer).
private-key (generic reader).
(setf private-key) (generic writer).
public-key (generic reader).
(setf public-key) (generic writer).
reason (generic reader).
(setf reason) (generic writer).
scp-get (function).
scp-input (generic function).
scp-output (generic function).
scp-put (function).
session (generic reader).
session-auth-methods-list (function).
session-disconnect (function).
session-handshake (function).
session-hostkey (function).
session-hostkey-fingerprint (function).
session-init (function).
session-last-error (function).
sftp-list-directory (function).
socket (generic reader).
(setf socket) (generic writer).
ssh-bad-hostkey (condition).
ssh-channel-exec (class).
ssh-channel-recv (class).
ssh-channel-send (class).
ssh-channel-stream (class).
ssh-channel-stream-input (class).
ssh-channel-stream-input/output (class).
ssh-channel-stream-output (class).
ssh-connection (class).
ssh-generic-error (condition).
ssh-handshake-error (condition).
ssh-session-key (generic function).
ssh-verify-session (generic function).
stream-finish-output* (generic function).
user-auth-agent (function).
user-auth-password (function).
user-auth-publickey (function).
with-agent (macro).
with-execute (macro).
with-execute* (macro).
with-known-hosts (macro).
with-scp-input (macro).
with-scp-output (macro).
with-session (macro).
with-ssh-connection (macro).
%agent-connect (function).
%agent-disconnect (function).
%agent-get-identity (function).
%agent-init (function).
%agent-list-identies (function).
%agent-userauth (function).
%channel-close (function).
%channel-eofp (function).
%channel-flush-ex (function).
%channel-free (function).
%channel-open-ex (function).
%channel-process-startup (function).
%channel-read-ex (function).
%channel-send-eof (function).
%channel-setenv-ex (function).
%channel-wait-closed (function).
%channel-wait-eof (function).
%channel-write-ex (function).
%known-hosts-addc (function).
%known-hosts-check (function).
%known-hosts-checkp (function).
%known-hosts-init (function).
%known-hosts-readfile (function).
%known-hosts-writefile (function).
%library-init (function).
%library-version (function).
%libssh2-sftp-close-handle (function).
%libssh2-sftp-fstat-ex (function).
%libssh2-sftp-fstatvfs (function).
%libssh2-sftp-get-channel (function).
%libssh2-sftp-init (function).
%libssh2-sftp-mkdir-ex (function).
%libssh2-sftp-open-ex (function).
%libssh2-sftp-read (function).
%libssh2-sftp-readdir-ex (function).
%libssh2-sftp-rename-ex (function).
%libssh2-sftp-rmdir-ex (function).
%libssh2-sftp-seek (function).
%libssh2-sftp-seek-64 (function).
%libssh2-sftp-shutdown (function).
%libssh2-sftp-stat-ex (function).
%libssh2-sftp-statvfs (function).
%libssh2-sftp-symlink-ex (function).
%libssh2-sftp-tell (function).
%libssh2-sftp-tell-64 (function).
%libssh2-sftp-unlink-ex (function).
%libssh2-sftp-write (function).
%scp-recv (function).
%scp-send-ex (function).
%session-auth-methods-list (function).
%session-disconnect (function).
%session-free (function).
%session-handshake (function).
%session-hostkey (function).
%session-last-error (function).
%user-auth-interactive (function).
%user-auth-password (function).
%user-auth-publickey (function).
*config-directory* (special variable).
*keyboard-interactive-password* (special variable).
*session* (special variable).
*sftp-session* (special variable).
*ssh-channel-buffer-size* (special variable).
*ssh-connection* (special variable).
+kbd-prompt+-tclass (class).
+kbd-response+-tclass (class).
+known-host+-tclass (class).
+sftp-read-buffer-size+ (constant).
.auth. (constant).
.base64. (constant).
.conn. (constant).
.error. (constant).
.kex. (constant).
.publickey (constant).
.raw. (constant).
.rsa1. (constant).
.scp. (constant).
.sftp. (constant).
.socket (constant).
.ssh. (constant).
.trans. (constant).
.type-plain. (constant).
.type-sha1. (constant).
_libssh2-sftp-attributes-tclass (class).
_libssh2-sftp-handle-tclass (class).
_libssh2-sftp-statvfs-tclass (class).
_libssh2-sftp-tclass (class).
auth-password-emul (class).
channel-scp-send (function).
channel-wait-eof (function).
channel-write-with-conv (macro).
copy-key (function).
default-config-directory (function).
default-known-hosts (function).
default-private-key (function).
default-public-key (function).
defcfun-error-check (macro).
ends-with-any? (function).
ends-with? (function).
get-universal-unix-time (function).
input-pos (generic reader).
(setf input-pos) (generic writer).
key-data (reader).
key-p (function).
key-size (reader).
key-type (reader).
library-exit (function).
library-init (function).
library-trace (function).
libssh2-invalid-error-code (condition).
libssh2-sftp-close-handle (function).
libssh2-sftp-fstat-ex (function).
libssh2-sftp-fstatvfs (function).
libssh2-sftp-get-channel (function).
libssh2-sftp-init (function).
libssh2-sftp-last-error (function).
libssh2-sftp-mkdir-ex (function).
libssh2-sftp-open-ex (function).
libssh2-sftp-read (function).
libssh2-sftp-readdir-ex (function).
libssh2-sftp-rename-ex (function).
libssh2-sftp-rmdir-ex (function).
libssh2-sftp-seek (function).
libssh2-sftp-seek-64 (function).
libssh2-sftp-shutdown (function).
libssh2-sftp-stat-ex (function).
libssh2-sftp-statvfs (function).
libssh2-sftp-symlink-ex (function).
libssh2-sftp-tell (function).
libssh2-sftp-tell-64 (function).
libssh2-sftp-unlink-ex (function).
libssh2-sftp-write (function).
login (generic reader).
make-key (function).
method-of (generic function).
print-memory (function).
result-or-error (macro).
session-free (function).
session-hostkey-hash (function).
session-init-ex (function).
session-last-errno (function).
session-set-blocking (function).
set-timeouts (function).
sftp-delete (function).
sftp-get (function).
ssh-authentication-failure (condition).
ssh-condition (condition).
ssh-host+port-format (generic function).
ssh-hostkey-condition (condition).
ssh-unknown-hostkey (condition).
ssh2.debug (macro).
ssh2.dribble (macro).
ssh2.error (macro).
ssh2.fatal (macro).
ssh2.info (macro).
ssh2.warn (macro).
throw-last-error (function).
user-auth-interactive (function).
user-auth-interactive-trivial (function).
usocket-get-fd (function).
with-last-error (macro).
with-sftp (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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"))
ssh-connection)) ¶automatically generated reader method
ssh-connection)) ¶automatically generated writer method
ssh-connection) (auth-list list)) ¶ssh-connection) (auth auth-agent)) ¶ssh-connection) (auth auth-publickey)) ¶ssh-connection) (auth auth-password-emul)) ¶ssh-connection) (auth auth-password)) ¶ssh-connection) (auth auth-data)) ¶ssh-connection) (login string)) ¶ssh-channel-stream)) ¶automatically generated reader method
ssh-channel-stream)) ¶automatically generated writer method
ssh-condition)) ¶ssh-condition)) ¶code.
ssh-connection) &key description lang) ¶ssh-connection) (command string)) ¶known-hosts-reading-error)) ¶known-hosts-reading-error)) ¶file.
ssh-hostkey-condition)) ¶ssh-hostkey-condition)) ¶hash.
ssh-connection)) ¶automatically generated reader method
host.
ssh-hostkey-condition)) ¶host.
ssh-connection)) ¶automatically generated writer method
host.
ssh-hostkey-condition)) ¶host.
ssh-connection)) ¶automatically generated reader method
ssh-connection)) ¶automatically generated writer method
ssh-channel-stream-input)) ¶automatically generated reader method
ssh-channel-stream-input)) ¶automatically generated writer method
ssh-channel-stream-input)) ¶automatically generated reader method
ssh-channel-stream-input)) ¶automatically generated writer method
ssh-condition)) ¶ssh-condition)) ¶ssh-channel-stream-output)) ¶automatically generated reader method
ssh-channel-stream-output)) ¶automatically generated writer method
ssh-channel-stream-output)) ¶automatically generated reader method
ssh-channel-stream-output)) ¶automatically generated writer method
ssh-channel-stream-output)) ¶automatically generated reader method
ssh-channel-stream-output)) ¶automatically generated writer method
auth-publickey)) ¶automatically generated reader method
auth-password-emul)) ¶automatically generated reader method
auth-password)) ¶automatically generated reader method
auth-publickey)) ¶automatically generated writer method
ssh-connection)) ¶automatically generated reader method
port.
ssh-connection)) ¶automatically generated writer method
port.
auth-publickey)) ¶automatically generated reader method
auth-publickey)) ¶automatically generated writer method
auth-publickey)) ¶automatically generated reader method
auth-publickey)) ¶automatically generated writer method
ssh-bad-hostkey)) ¶ssh-bad-hostkey)) ¶ssh-connection) (path string)) ¶ssh-connection) (path string) size &key mode mtime atime) ¶ssh-connection)) ¶automatically generated reader method
ssh-channel-stream)) ¶automatically generated reader method
ssh-connection)) ¶automatically generated reader method
ssh-channel-stream)) ¶automatically generated writer method
ssh-connection)) ¶automatically generated writer method
ssh-connection)) ¶ssh-connection)) ¶ssh-channel-stream-output) &key dont-send-eof) ¶ssh-channel-stream) &key abort) ¶libssh2-invalid-error-code) &key) ¶ssh-channel-stream)) ¶known-hosts-reading-error) stream) ¶ssh-channel-stream)) ¶ssh-channel-stream)) ¶sb-gray.
ssh-channel-stream-output)) ¶sb-gray.
ssh-channel-stream)) ¶sb-gray.
ssh-channel-stream-output)) ¶sb-gray.
ssh-channel-stream)) ¶sb-gray.
ssh-channel-stream-input)) ¶sb-gray.
ssh-channel-stream-input)) ¶sb-gray.
ssh-channel-recv) thing start end &key) ¶trivial-gray-streams.
ssh-channel-stream-input) thing start end &key) ¶trivial-gray-streams.
ssh-channel-stream-output) byte) ¶sb-gray.
ssh-channel-stream-output) char) ¶sb-gray.
ssh-channel-stream-output) sequence start end &key) ¶trivial-gray-streams.
ssh-channel-stream-output) (sharable-sequence string) start end &key) ¶trivial-gray-streams.
:reason
Signalled when a non-correctable condition occurs during a libssh2 call.
error.
ssh-condition.
string
"id_rsa.pub"
:public-key
string
"id_rsa"
:private-key
string
""
:password
fundamental-binary-input-stream.
fundamental-binary-output-stream.
fundamental-character-input-stream.
fundamental-character-output-stream.
ssh-channel-stream-input/output.
fundamental-binary-input-stream.
ssh-channel-stream-input.
fundamental-binary-output-stream.
ssh-channel-stream-output.
(cffi-sys:make-shareable-byte-vector libssh2::*ssh-channel-buffer-size*)
libssh2::int
0
libssh2::int
0
(cffi-sys:make-shareable-byte-vector libssh2::*ssh-channel-buffer-size*)
libssh2::int
0
libssh2::int
0
(setf auth-passed).
auth-passed.
authentication.
authentication.
authentication.
authentication.
authentication.
authentication.
authentication-methods.
destroy-ssh-connection.
execute.
(setf host).
host.
(setf hosts-db).
hosts-db.
(setf port).
port.
scp-input.
scp-output.
session.
(setf socket).
socket.
ssh-host+port-format.
ssh-session-key.
ssh-verify-session.
libssh2:+session+
(cffi-sys:null-pointer)
:session
This slot is read-only.
usocket:socket
:socket
string
:hosts-db
boolean
Dynamic variable which is bound to a foreign reference representing the SFTP session (in libssh2 terms).
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.
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.
Delete a remote file ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’.
Receive a remote file ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’ to a local file at ‘LOCAL-PATH’.
ssh-channel-stream-input)) ¶automatically generated reader method
ssh-channel-stream-input)) ¶automatically generated writer method
auth-agent)) ¶auth-publickey)) ¶auth-password)) ¶ssh-connection)) ¶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.’
is thrown in case authentication failed without specific error code~%
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.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
A C D E F G H I K L M O P R S T U W |
|---|
| Jump to: | %
(
A C D E F G H I K L M O P R S T U W |
|---|
| Jump to: | *
+
.
A C D F H I L M O P R S T |
|---|
| Jump to: | *
+
.
A C D F H I L M O P R S T |
|---|
| Jump to: | +
_
A C F K L M P S T U |
|---|
| Jump to: | +
_
A C F K L M P S T U |
|---|