This is the cl-ftp Reference Manual, version 1.6.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:55:11 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-ftpFTP library
pinterface <pix@kepibu.org>
Matthew Danish <mdanish@andrew.cmu.edu>
MIT/X style
Provides FTP client functionality
1.6.0
split-sequence (system).
usocket (system).
ftp.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-ftp/ftp.lispcl-ftp (system).
call-with-transfer-socket (generic function).
close-connection (generic function).
code-cut-off-p (reader method).
(setf code-cut-off-p) (writer method).
connect-to-server (generic function).
data-ready-p (generic function).
data-to-string (function).
error-message (reader method).
expected (reader method).
ftp-connection (class).
ftp-error (condition).
ftp-error-code (reader method).
ftp-hostname (reader method).
ftp-password (reader method).
ftp-port (reader method).
ftp-session-stream (reader method).
ftp-username (reader method).
initialize-instance (method).
invalid-code (condition).
passive-ftp-p (reader method).
(setf passive-ftp-p) (writer method).
permanent-negative-completion (condition).
print-object (method).
receive-response (generic function).
received (reader method).
retrieve-file (generic function).
retrieve-file-info-list (generic function).
retrieve-filename-list (generic function).
send-cdup-command (generic function).
send-cwd-command (generic function).
send-dele-command (generic function).
send-list-command (generic function).
send-mkd-command (generic function).
send-nlst-command (generic function).
send-pwd-command (generic function).
send-size-command (generic function).
store-file (generic function).
transient-negative-completion (condition).
with-ftp-connection (macro).
with-transfer-socket (macro).
%doc-fns (macro).
%get-arg-name (function).
%parse-body (function).
clean-ftp-response (function).
def-simple-command (macro).
establish-data-transfer (generic function).
expect-code-or-lose (generic function).
flush-response (generic function).
log-session (generic function).
maybe-cut-off-code (function).
parse-257-response (function).
raise-ftp-error (function).
receive-pasv-response (generic function).
send-port-command (generic function).
send-raw-line (generic function).
setup-port (generic function).
with-ftp-connection-slots (macro).
Packages are listed by definition order.
org.mapcar.ftp.clientftp.client
ftp
common-lisp.
split-sequence.
usocket.
call-with-transfer-socket (generic function).
close-connection (generic function).
code-cut-off-p (generic reader).
(setf code-cut-off-p) (generic writer).
connect-to-server (generic function).
data-ready-p (generic function).
data-to-string (function).
error-message (generic reader).
expected (generic reader).
ftp-connection (class).
ftp-error (condition).
ftp-error-code (generic reader).
ftp-hostname (generic reader).
ftp-password (generic reader).
ftp-port (generic reader).
ftp-session-stream (generic reader).
ftp-username (generic reader).
invalid-code (condition).
passive-ftp-p (generic reader).
(setf passive-ftp-p) (generic writer).
permanent-negative-completion (condition).
receive-response (generic function).
received (generic reader).
retrieve-file (generic function).
retrieve-file-info-list (generic function).
retrieve-filename-list (generic function).
send-cdup-command (generic function).
send-cwd-command (generic function).
send-dele-command (generic function).
send-list-command (generic function).
send-mkd-command (generic function).
send-nlst-command (generic function).
send-pwd-command (generic function).
send-size-command (generic function).
store-file (generic function).
transient-negative-completion (condition).
with-ftp-connection (macro).
with-transfer-socket (macro).
%doc-fns (macro).
%get-arg-name (function).
%parse-body (function).
clean-ftp-response (function).
def-simple-command (macro).
establish-data-transfer (generic function).
expect-code-or-lose (generic function).
flush-response (generic function).
log-session (generic function).
maybe-cut-off-code (function).
parse-257-response (function).
raise-ftp-error (function).
receive-pasv-response (generic function).
send-port-command (generic function).
send-raw-line (generic function).
setup-port (generic function).
with-ftp-connection-slots (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Opens and ensures proper close of an FTP connection. Binds connection-variable to the FTP-CONNECTION object in the scope of body. Arguments are similar to that of the initargs for the class FTP-CONNECTION.
Opens a data transfer socket in the scope of body, using the given FTP connection and executing the given FTP command-string. If :REST is specified, then the FTP "REST" command will be sent with the value of the argument. :TYPE may be :BINARY or :ASCII. Closes the transfer-socket upon dynamic exit of body.
Converts a list of strings, such as that produced by receive-response, to one string with newlines after each formerly-list-element.
Similar to WITH-TRANSFER-SOCKET, except that function is a function which accepts a single argument; namely the transfer-socket
ftp-connection) (command string) (fn function) &rest args) ¶Closes the given FTP connection
ftp-connection)) ¶Non-nil iff FTP codes are to be cut-off when logging
ftp-connection)) ¶When non-nil, cut-off FTP codes in logging output
Alter value of code-cut-off-p
ftp-connection)) ¶When non-nil, cut-off FTP codes in logging output
Attempts to connect to the server using the information provided by connection-variable. If connection-variable represents an existing connection, then that connection will be closed and a new one established.
ftp-connection)) ¶Non-nil iff data is waiting to be read from the control connection.
ftp-connection)) ¶invalid-code)) ¶The remote hostname
ftp-connection)) ¶The remote hostname
The login password
ftp-connection)) ¶The login password
The remote port
ftp-connection)) ¶The remote port
The session stream for the FTP connection
ftp-connection)) ¶Send FTP session output to this stream, if non-nil
The login username
ftp-connection)) ¶The login username
Non-nil iff given FTP connection is to use passive FTP for data transfers
ftp-connection)) ¶Use passive FTP if non-nil
Value should be non-nil to use passive FTP for data transfers with the given FTP connection
ftp-connection)) ¶Use passive FTP if non-nil
Receives a response from the FTP server. Returns a list of strings as the first value and the response code as the second. If :BLOCK is T, then will block until response received. Otherwise return NIL if nothing is available currently.
ftp-connection) &key block) ¶invalid-code)) ¶Retrieves a file given a remote filename, and a local filename or stream. :TYPE is either :ASCII or :BINARY, and :REST specifies an integer amount to seek into the file before retrieving it.
ftp-connection) (remote-filename string) (local-stream stream) &key type rest) ¶ftp-connection) (remote-filename string) local-filename &key type rest if-exists) ¶Retrieves a list of the form (type name) where type is :DIRECTORY or :FILE and name is a filename in the given directory named by pathname. Note: this is implemented by attempting CWDs, and may break if the FTP server does strange things.
ftp-connection) &optional pathname) ¶Retrieves a list of filenames for the given pathname.
ftp-connection) &optional pathname) ¶Sends the FTP CDUP command.
ftp-connection)) ¶Sends the FTP CWD command, to change to the given remote-directory. If remote-directory is "..", CDUP is sent instead. Signals error if not possible.
ftp-connection) (remote-dir string)) ¶ftp-connection) (remote-filename string)) ¶Sends the FTP LIST command. If OUTPUT is NIL, returns a string. If OUTPUT is T, prints to *standard-output*. Otherwise, it treats OUTPUT as the output stream.
ftp-connection) (output stream) &optional pathname) ¶ftp-connection) output &optional pathname) ¶ftp-connection) (output null) &optional pathname) ¶Sends the FTP MKD command to make a remote directory. Returns directory name as string. Signals error if not possible.
ftp-connection) (dir-name string)) ¶Sends the FTP NLST command. If OUTPUT is NIL, returns a string. If OUTPUT is T, prints to *standard-output*. Otherwise, it treats OUTPUT as the output stream.
ftp-connection) (output stream) &optional pathname) ¶ftp-connection) output &optional pathname) ¶ftp-connection) (output null) &optional pathname) ¶Sends the FTP PWD command and returns the current working directory as a string.
ftp-connection)) ¶Sends the FTP SIZE command on the given remote-filename. Returns an integer size. Signals error if no such file.
ftp-connection) (remote-filename string)) ¶Stores a file given a local filename or stream and a remote filename. :TYPE is either :ASCII or :BINARY.
ftp-connection) (local-stream stream) (remote-filename string) &key type rest) ¶ftp-connection) local-filename (remote-filename string) &key type rest) ¶ftp-connection) &rest initargs) ¶ftp-connection) stream) ¶condition.
Code associated with message
(quote "\"unspecified\"")
:ftp-error-code
This slot is read-only.
FTP server’s error message
(quote "\"unspecified\"")
:error-message
This slot is read-only.
Signalled when a permanent error is received from the FTP server. This means that the input was not acceptable and should not be re-sent.
Signalled when a transient error is received from the FTP server. This means that the input was fine, but something else went wrong. Feel free to resend.
Represents an FTP connection and associated state. The INITIALIZE-INSTANCE :AFTER method takes care of connection and login, if possible.
call-with-transfer-socket.
close-connection.
(setf code-cut-off-p).
code-cut-off-p.
connect-to-server.
data-ready-p.
establish-data-transfer.
expect-code-or-lose.
flush-response.
ftp-hostname.
ftp-password.
ftp-port.
ftp-session-stream.
ftp-username.
initialize-instance.
log-session.
log-session.
(setf passive-ftp-p).
passive-ftp-p.
print-object.
receive-pasv-response.
receive-response.
retrieve-file.
retrieve-file.
retrieve-file-info-list.
retrieve-filename-list.
send-cdup-command.
send-cwd-command.
send-dele-command.
send-list-command.
send-list-command.
send-list-command.
send-mkd-command.
send-nlst-command.
send-nlst-command.
send-nlst-command.
send-port-command.
send-pwd-command.
send-raw-line.
send-size-command.
setup-port.
store-file.
store-file.
The remote hostname
:hostname
This slot is read-only.
The remote port
21
:port
This slot is read-only.
The login username
"anonymous"
:username
This slot is read-only.
The login password
"cl-ftp@cclan.net"
:password
This slot is read-only.
Send FTP session output to this stream, if non-nil
:session-stream
This slot is read-only.
Use passive FTP if non-nil
:passive-ftp-p
When non-nil, cut-off FTP codes in logging output
t
:code-cut-off-p
usocket.
ftp-connection) (command string) &key rest type) ¶ftp-connection) (expected-code integer)) ¶ftp-connection)) ¶ftp-connection) (data list)) ¶ftp-connection) (data string)) ¶ftp-connection)) ¶ftp-connection) (ip string) (port-num integer)) ¶ftp-connection) (line string)) ¶ftp-connection) &key element-type) ¶| Jump to: | %
(
C D E F G I L M P R S W |
|---|
| Jump to: | %
(
C D E F G I L M P R S W |
|---|
| Jump to: | C E F H P R S U |
|---|
| Jump to: | C E F H P R S U |
|---|
| Jump to: | C F I O P S T |
|---|
| Jump to: | C F I O P S T |
|---|