The purgatory Reference Manual

3.1.1 purgatory/purgatory.asd

Source

purgatory.asd.

Parent Component

purgatory (system).

ASDF Systems

purgatory.

---

3.1.2 purgatory/package.lisp

Source

purgatory.asd.

Parent Component

purgatory (system).

Packages

• purgatory.filesystem-utils.
• purgatory.misc-utils.
• purgatory.
• purgatory.text-utils.

---

3.1.3 purgatory/text-utils.lisp

Dependency

package.lisp (file).

Source

purgatory.asd.

Parent Component

purgatory (system).

Public Interface

strcat (function).

Internals

strcat* (function).

---

3.1.4 purgatory/misc-utils.lisp

Dependency

text-utils.lisp (file).

Source

purgatory.asd.

Parent Component

purgatory (system).

Public Interface

safe-all-but-last-elt (function).

Internals

• defcond (macro).
• delete@ (generic function).
• gen-delete@ (macro).
• idx (reader method).
• out-of-bounds (condition).
• safe-delete@ (generic function).
• seq (reader method).
• text (reader method).
• text-error (condition).

---

3.1.5 purgatory/filesystem-utils.lisp

Dependency

misc-utils.lisp (file).

Source

purgatory.asd.

Parent Component

purgatory (system).

Public Interface

• *directory-sep-regexp* (special variable).
• backreference-dir-p (function).
• cat-parent-dir (function).
• getenv (function).
• loopback-reference-dir-p (function).
• parent-dir-path (function).
• path-last-element (function).
• path-referencing-dir-p (function).
• split-path-elements (function).

Internals

• *directory-sep* (special variable).
• +file-path-regex+ (constant).

---

3.1.6 purgatory/conditions.lisp

Dependency

filesystem-utils.lisp (file).

Source

purgatory.asd.

Parent Component

purgatory (system).

Public Interface

9p-error (condition).

Internals

• 9p-authorization-error (condition).
• 9p-initialization-error (condition).
• connection-data (reader method).
• error-value (reader method).
• message-type (reader method).
• rtag (reader method).
• tag (reader method).
• tag (reader method).

---

3.1.7 purgatory/message-types.lisp

Dependency

conditions.lisp (file).

Source

purgatory.asd.

Parent Component

purgatory (system).

Internals

• *rattach* (special variable).
• *rauth* (special variable).
• *rclunk* (special variable).
• *rcreate* (special variable).
• *rerror* (special variable).
• *rflush* (special variable).
• *ropen* (special variable).
• *rread* (special variable).
• *rremove* (special variable).
• *rstat* (special variable).
• *rversion* (special variable).
• *rwalk* (special variable).
• *rwrite* (special variable).
• *rwstat* (special variable).
• *tattach* (special variable).
• *tauth* (special variable).
• *tclunk* (special variable).
• *tcreate* (special variable).
• *terror* (special variable).
• *tflush* (special variable).
• *topen* (special variable).
• *tread* (special variable).
• *tremove* (special variable).
• *tstat* (special variable).
• *tversion* (special variable).
• *twalk* (special variable).
• *twrite* (special variable).
• *twstat* (special variable).

---

3.1.8 purgatory/client.lisp

Dependency

message-types.lisp (file).

Source

purgatory.asd.

Parent Component

purgatory (system).

Public Interface

• *buffer-size* (special variable).
• *fid* (special variable).
• *messages-sent* (special variable).
• *tag* (special variable).
• +byte-type+ (constant).
• +create-dir+ (constant).
• +create-for-exec+ (constant).
• +create-for-read+ (constant).
• +create-for-read-write+ (constant).
• +create-for-write+ (constant).
• +nofid+ (constant).
• +nwname-clone+ (constant).
• +open-remove-on-clunk+ (constant).
• +open-truncate+ (constant).
• +standard-socket-port+ (constant).
• +version+ (constant).
• 9p-attach (generic function).
• 9p-auth (function).
• 9p-clunk (function).
• 9p-create (function).
• 9p-open (function).
• 9p-read (function).
• 9p-remove (function).
• 9p-stat (function).
• 9p-walk (function).
• 9p-write (generic function).
• change-access-time (function).
• change-mode (function).
• change-modify-time (function).
• change-permissions (function).
• change-time-values (function).
• clone-fid (function).
• close-client (function).
• collect-directory-children (function).
• collect-tree (function).
• copy-file (function).
• create-directory (function).
• create-path (function).
• decode (generic function).
• decode-read-reply (function).
• decode-rstat (function).
• decode-string (method).
• dummy-callback (function).
• dump-callback (function).
• encode (generic function).
• encode-string (function).
• initialize-session (function).
• make-permissions (function).
• make-stat (function).
• mount (function).
• move-file (function).
• open-directory (function).
• open-path (function).
• path-exists-p (function).
• path-info (function).
• permissions-group (reader).
• (setf permissions-group) (writer).
• permissions-group-string (reader).
• (setf permissions-group-string) (writer).
• permissions-original-value (reader).
• (setf permissions-original-value) (writer).
• permissions-others (reader).
• (setf permissions-others) (writer).
• permissions-others-string (reader).
• (setf permissions-others-string) (writer).
• permissions-user (reader).
• (setf permissions-user) (writer).
• permissions-user-string (reader).
• (setf permissions-user-string) (writer).
• read-all-pending-messages (function).
• read-all-pending-messages-ignoring-errors (function).
• read-directory (function).
• read-entire-file-apply-function (function).
• read-message (function).
• remove-path (function).
• slurp-file (function).
• sort-dir-stats (function).
• stat-atime (reader).
• (setf stat-atime) (writer).
• stat-entry-size (reader).
• (setf stat-entry-size) (writer).
• stat-entry-type (reader).
• (setf stat-entry-type) (writer).
• stat-group-id (reader).
• (setf stat-group-id) (writer).
• stat-kdev (reader).
• (setf stat-kdev) (writer).
• stat-ktype (reader).
• (setf stat-ktype) (writer).
• stat-last-modified-from-id (reader).
• (setf stat-last-modified-from-id) (writer).
• stat-mode (reader).
• (setf stat-mode) (writer).
• stat-mtime (reader).
• (setf stat-mtime) (writer).
• stat-name (reader).
• (setf stat-name) (writer).
• stat-path (reader).
• (setf stat-path) (writer).
• stat-size (reader).
• (setf stat-size) (writer).
• stat-user-id (reader).
• (setf stat-user-id) (writer).
• stat-version (reader).
• (setf stat-version) (writer).
• truncate-file (function).
• with-new-fid (macro).
• with-new-tag (macro).

Internals

• %9p-walk-self (function).
• *unix-epoch-difference* (special variable).
• +9p-read-header-fixed-size+ (constant).
• +9p-write-header-fixed-size+ (constant).
• +file-types+ (constant).
• +message-length-size+ (constant).
• +message-string-length-size+ (constant).
• +message-tag-size+ (constant).
• +message-type-size+ (constant).
• +stat-type-append+ (constant).
• +stat-type-auth+ (constant).
• +stat-type-dir+ (constant).
• +stat-type-excl+ (constant).
• +stat-type-exec+ (constant).
• +stat-type-file+ (constant).
• +stat-type-mount+ (constant).
• +stat-type-read+ (constant).
• +stat-type-symlink+ (constant).
• +stat-type-tmp+ (constant).
• +stat-type-write+ (constant).
• +wstat-ignore-1+ (constant).
• +wstat-ignore-2+ (constant).
• +wstat-ignore-4+ (constant).
• +wstat-ignore-8+ (constant).
• 9p-wstat (generic function).
• add-size (function).
• append-tag-callback (function).
• big-endian->little-endian (function).
• bytes->int (function).
• cat-reply-vector (function).
• change-time (function).
• close-ssl-socket (function).
• compose-message (function).
• copy-permissions (function).
• copy-stat (function).
• decode-permissions (function).
• decode-quid (function).
• displace-response (function).
• encode-permissions (function).
• encoded-string-offset (function).
• error-response-p (function).
• exhausted-stream-for-read-p (function).
• file-type-number->symbol (function).
• fire-response (function).
• gen-intn->bytes (macro).
• ignore-response (function).
• int16->bytes (function).
• int32->bytes (function).
• int416->bytes (function).
• int512->bytes (function).
• int64->bytes (function).
• int8->bytes (function).
• make-message-buffer (function).
• make-octects (function).
• make-octects-permissions (function).
• maximum-read-buffer-size (function).
• next-fid (function).
• next-tag (function).
• octects (class).
• octects= (generic function).
• permissions (structure).
• permissions->list (function).
• permissions->string (function).
• permissions-p (function).
• send-message (function).
• send-version (function).
• size (reader method).
• (setf size) (writer method).
• stat (structure).
• stat-p (function).
• symbol->file-type-number (function).
• tags-exists-p-clsr (function).
• universal->unix (function).
• unix->universal (function).
• value (reader method).
• (setf value) (writer method).
• vcat (function).
• with-callback-read-all (macro).

---

5.1.1 Constants

Constant: +byte-type+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +create-dir+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +create-for-exec+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +create-for-read+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +create-for-read-write+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +create-for-write+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +nofid+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +nwname-clone+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +open-remove-on-clunk+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +open-truncate+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +standard-socket-port+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +version+ ¶

Package

purgatory.

Source

client.lisp.

---

5.1.2 Special variables

Special Variable: *buffer-size* ¶

Package

purgatory.

Source

client.lisp.

Special Variable: *directory-sep-regexp* ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Special Variable: *fid* ¶

Package

purgatory.

Source

client.lisp.

Special Variable: *messages-sent* ¶

Package

purgatory.

Source

client.lisp.

Special Variable: *tag* ¶

Package

purgatory.

Source

client.lisp.

---

5.1.3 Macros

Macro: with-new-fid ((fid) &body body) ¶

Useful convenience macro to generate a new fid

Package

purgatory.

Source

client.lisp.

Macro: with-new-tag ((tag) &body body) ¶

Package

purgatory.

Source

client.lisp.

---

5.1.4 Ordinary functions

Function: 9p-auth (stream authorization-fid username root &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: 9p-clunk (stream fid &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: 9p-create (stream parent-dir-fid path &key callback permissions mode) ¶

Note: path is relative to root, see attach,
Also note that successfully creating a file will open it.

Package

purgatory.

Source

client.lisp.

Function: 9p-open (stream fid &key callback mode) ¶

Note: before opening you have to ’walk’ the file to get the corresponding fid.

Package

purgatory.

Source

client.lisp.

Function: 9p-read (stream fid offset chunk-length &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: 9p-remove (stream fid &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: 9p-stat (stream fid &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: 9p-walk (stream root-fid new-fid new-name &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: backreference-dir-p (path) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Function: cat-parent-dir (parent direntry) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Function: change-access-time (stream root-fid path time &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: change-mode (stream root-fid path new-mode &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: change-modify-time (stream root-fid path time &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: change-permissions (stream root-fid path new-mode &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: change-time-values (stream root-fid path new-access-time new-modification-time &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: clone-fid (stream fid) ¶

Make a new fid that points to the same resource pointed by ‘fid’

Package

purgatory.

Source

client.lisp.

Function: close-client (socket) ¶

Package

purgatory.

Source

client.lisp.

Function: collect-directory-children (stream root-fid path) ¶

Collect all the directory entries of ‘path’ relative to ‘root-fid’ as a list of ‘stat‘ structures.

Package

purgatory.

Source

client.lisp.

Function: collect-tree (stream root-fid starting-directory) ¶

Traverse the file system tree starting at ‘starting-directory’ returning two values
- a list of strings representing the paths of all the *files*
under ‘starting-directory’
- a list of all the path to the sub-directories under ‘starting-directory’

The lists are ordered in topological order (depth first strategy).

Package

purgatory.

Source

client.lisp.

Function: copy-file (stream root-fid path-from path-to &key buffer-size progress-fn) ¶

Copy a file pointed by ‘path-from’ to a file pointed by ‘path-to’. ‘progress-fn’, if defined, must be a function with a single parameter: the number of octects wrote in a single call of the Twrite command.

Note: the destination file is overwritten if does exists.

Package

purgatory.

Source

client.lisp.

Function: create-directory (stream parent-fid directory-name &key permissions) ¶

Create a new directory with name ‘directory-name’ under the directory pointed by ‘parent-fid’. The parameter ‘permissions’ must be provided in octal (default: #o760))

Package

purgatory.

Source

client.lisp.

Function: create-path (stream parent-fid path &key file-permissions) ¶

Create a file or directory as specified by ‘path’.
To create a directory specify a path terminating with a ’/’. Parent directories are created if do not exist. The parameter ‘permissions’ must be provided in octal (default: #o640))

Returns the fid to the last element of ‘path’

If the last element of ‘path’ is a directory the directory is created with permissions: #o760.

It ‘path’ already reference a valid file it is opened for read and write.

Finally if already reference a valid directory is opened for read only.

Package

purgatory.

Source

client.lisp.

Function: decode-read-reply (data &optional as-string) ¶

Package

purgatory.

Source

client.lisp.

Function: decode-rstat (data) ¶

Decode a serialized file/directory entry in a structure ‘stat’.

Package

purgatory.

Source

client.lisp.

Function: dummy-callback (message-type data) ¶

A callback that does nothing

Package

purgatory.

Source

client.lisp.

Function: dump-callback (message-type data) ¶

A callback that print the data on the standard output, useful for debugging

Package

purgatory.

Source

client.lisp.

Function: encode-string (string) ¶

Package

purgatory.

Source

client.lisp.

Function: getenv (name) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Function: initialize-session (stream) ¶

Package

purgatory.

Source

client.lisp.

Function: loopback-reference-dir-p (path) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Function: make-permissions (&key user group others user-string group-string others-string original-value) ¶

Package

purgatory.

Source

client.lisp.

Function: make-stat (&key entry-size ktype kdev entry-type version path mode atime mtime size name user-id group-id last-modified-from-id) ¶

Package

purgatory.

Source

client.lisp.

Function: mount (stream root-path &key username authorization-handshake) ¶

Initialize the connection to the server using ‘root-path’ as the root of the remote file system

If ‘username’ is not nil ‘authorization-handshake’ must be a function of two parameters

- stream
- authorization-fid

The user can write and read to authorization-fid using ‘9p-write’ or ‘9p-read’ to be authorized. If authorized ‘authorization-handshake’ must returns a non nil value. If returns a nil value this is interpreted as access not granted and ‘mount’ returns nil.

If mount has success two values are returned: the fid of the root file system and the protocol version.

Package

purgatory.

Source

client.lisp.

Function: move-file (stream root-fid path-from path-to &key buffer-size progress-fn) ¶

Move the file from ‘path-from‘ ‘path-to‘, this function can be used to rename a file too.

Package

purgatory.

Source

client.lisp.

Function: open-directory (stream root-fid path) ¶

Open the directory pointed to ‘path’ relative to ‘root-fid’. Returns the fid of the directory pointed by ‘path’.

This fid can be used by ‘read-directory‘ to get the directory entries (see the struct ‘stat’)

Package

purgatory.

Source

client.lisp.

Function: open-path (stream root-fid path &key walk-callback open-callback mode just-walk) ¶

Open a full, existing, path relative to ‘root-fid’. ‘Mode’ must be one of +create-for-read+, +create-for-write+, +create-for-read-write+

Package

purgatory.

Source

client.lisp.

Function: parent-dir-path (path) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Function: path-exists-p (stream root-fid path) ¶

Returns non nil if ‘path’ exists.

Package

purgatory.

Source

client.lisp.

Function: path-info (stream root-fid path) ¶

If returns non nil values a stat structure representing the element pointed by ‘path’ and a list of stats structures corresponding to the directory of ‘path’.

Package

purgatory.

Source

client.lisp.

Function: path-last-element (path) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Function: path-referencing-dir-p (path) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Reader: permissions-group (instance) ¶

Writer: (setf permissions-group) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

group.

Reader: permissions-group-string (instance) ¶

Writer: (setf permissions-group-string) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

group-string.

Reader: permissions-original-value (instance) ¶

Writer: (setf permissions-original-value) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

original-value.

Reader: permissions-others (instance) ¶

Writer: (setf permissions-others) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

others.

Reader: permissions-others-string (instance) ¶

Writer: (setf permissions-others-string) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

others-string.

Reader: permissions-user (instance) ¶

Writer: (setf permissions-user) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

user.

Reader: permissions-user-string (instance) ¶

Writer: (setf permissions-user-string) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

user-string.

Function: read-all-pending-messages (stream) ¶

The responses from the server are not processed immediately, they are collected until this function is called.

Package

purgatory.

Source

client.lisp.

Function: read-all-pending-messages-ignoring-errors (stream) ¶

Read all the messages from the server and ignore any error

Package

purgatory.

Source

client.lisp.

Function: read-directory (stream dir-fid &optional offset) ¶

Read the next entry of a directory specified by ‘dir-fid’.

‘Dir-fid’ is usually the values returned by ‘open-directory‘.

This function on success returns tree values:

- dir-fid to read the next entry or to check if there are no more
entries (see below);
- the stat struct for the current entry;
- an offset to the next entry.

Each call to this function on the same directory fid, except the first, must use the offset returned by the last call, for example

(let* ((dir-fid (open-directory stream root-fid path))
(multiple-value-bind (next-dir-fid stat stat-size)
(read-directory stream dir-fid) ; offset 0 on the first call
(multiple-value-bind (next-dir-fid-2 stat-2 next-stat-size-2)
(read-directory stream dir-fid stat-size) ; offset equals
; to stat-size
; from previous
; call
...))))

When this function returns nil there no more entries for this
directory (see the code of directory children).

Package

purgatory.

Source

client.lisp.

Function: read-entire-file-apply-function (stream root-fid path read-function &key buffer-size) ¶

Read an entire file pointed by ‘path’ applying the function ‘read-function’ to three arguments:

- the data chunk as a vector of (unsigned-byte 8);
- the offset to the start of the chunk red;
- the length of the chunk.

Note: ‘path’ is relative to ‘root-fid’

Note also that a failed assertion is signalled if ‘buffer-size’ is bigger than:

*buffer-size* - +9p-read-header-fixed-size+

Package

purgatory.

Source

client.lisp.

Function: read-message (stream) ¶

Package

purgatory.

Source

client.lisp.

Function: remove-path (stream root-fid path) ¶

Remove the last element of ’path’ relative to ‘root-fid’. If ‘path’ does not exists this function does nothing.

Package

purgatory.

Source

client.lisp.

Function: safe-all-but-last-elt (sequence) ¶

Package

purgatory.misc-utils.

Source

misc-utils.lisp.

Function: slurp-file (stream root-fid path &key buffer-size) ¶

Read in a vector of (unsigned-byte 8) the full content of
’path’ relative to ‘root-fid’

Note: a failed assertion is signalled if ‘buffer-size’ is bigger than:

*buffer-size* - +9p-read-header-fixed-size+

Package

purgatory.

Source

client.lisp.

Function: sort-dir-stats (data &optional fn) ¶

Sort a list of stat struct ‘data’ (by default sorting entry names in lexicographic ascending order

Package

purgatory.

Source

client.lisp.

Function: split-path-elements (path) ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Reader: stat-atime (instance) ¶

Writer: (setf stat-atime) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

atime.

Reader: stat-entry-size (instance) ¶

Writer: (setf stat-entry-size) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

entry-size.

Reader: stat-entry-type (instance) ¶

Writer: (setf stat-entry-type) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

entry-type.

Reader: stat-group-id (instance) ¶

Writer: (setf stat-group-id) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

group-id.

Reader: stat-kdev (instance) ¶

Writer: (setf stat-kdev) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

kdev.

Reader: stat-ktype (instance) ¶

Writer: (setf stat-ktype) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

ktype.

Reader: stat-last-modified-from-id (instance) ¶

Writer: (setf stat-last-modified-from-id) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

last-modified-from-id.

Reader: stat-mode (instance) ¶

Writer: (setf stat-mode) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

mode.

Reader: stat-mtime (instance) ¶

Writer: (setf stat-mtime) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

mtime.

Reader: stat-name (instance) ¶

Writer: (setf stat-name) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

name.

Reader: stat-path (instance) ¶

Writer: (setf stat-path) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

path.

Reader: stat-size (instance) ¶

Writer: (setf stat-size) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

size.

Reader: stat-user-id (instance) ¶

Writer: (setf stat-user-id) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

user-id.

Reader: stat-version (instance) ¶

Writer: (setf stat-version) (instance) ¶

Package

purgatory.

Source

client.lisp.

Target Slot

version.

Function: strcat (&rest chunks) ¶

Package

purgatory.text-utils.

Source

text-utils.lisp.

Function: truncate-file (stream root-fid path &key new-size callback) ¶

Truncate the size of the element pointed by ‘path’ to the size indicated by the value of ‘new-size’ (default 0). Note that only files could be truncated, not directory.

Package

purgatory.

Source

client.lisp.

---

5.1.5 Generic functions

Generic Function: 9p-attach (stream root &key username callback afid) ¶

Package

purgatory.

Source

client.lisp.

Methods

Method: 9p-attach (stream (root string) &key username callback afid) ¶

Generic Function: 9p-write (stream fid offset data &key callback) ¶

Package

purgatory.

Source

client.lisp.

Methods

Method: 9p-write (stream fid offset (data string) &key callback) ¶

Method: 9p-write (stream fid offset (data vector) &key callback) ¶

Generic Function: decode (object) ¶

Package

purgatory.

Source

client.lisp.

Generic Function: decode-string (data) ¶

Package

purgatory.

Methods

Method: decode-string (data) ¶

Source

client.lisp.

Generic Function: encode (object) ¶

Package

purgatory.

Source

client.lisp.

Methods

Method: encode ((object stat)) ¶

Method: encode ((object permissions)) ¶

Method: encode (object) ¶

Method: encode ((object list)) ¶

Method: encode ((object string)) ¶

Method: encode ((object octects)) ¶

Encode an octect to be trasmitted on the stream

---

5.1.6 Conditions

Condition: 9p-error ¶

Error for 9p protocol

Package

purgatory.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

• error-value.
• message-type.
• tag.

Direct slots

Slot: error-value ¶

Initargs

:error-value

Readers

error-value.

Writers

This slot is read-only.

Slot: message-type ¶

Initargs

:message-type

Readers

message-type.

Writers

This slot is read-only.

Slot: tag ¶

Initargs

:tag

Readers

tag.

Writers

This slot is read-only.

---

5.2.1 Constants

Constant: +9p-read-header-fixed-size+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +9p-write-header-fixed-size+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +file-path-regex+ ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Constant: +file-types+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +message-length-size+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +message-string-length-size+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +message-tag-size+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +message-type-size+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-append+ ¶

mode bit for append only files

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-auth+ ¶

mode bit for authentication file

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-dir+ ¶

mode bit for directories

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-excl+ ¶

mode bit for exclusive use files

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-exec+ ¶

mode bit for execute permission

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-file+ ¶

mode bit for non-backed-up files

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-mount+ ¶

mode bit for mounted channel

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-read+ ¶

mode bit for read permission

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-symlink+ ¶

mode bit for non-backed-up files

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-tmp+ ¶

mode bit for non-backed-up files

Package

purgatory.

Source

client.lisp.

Constant: +stat-type-write+ ¶

mode bit for write permission

Package

purgatory.

Source

client.lisp.

Constant: +wstat-ignore-1+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +wstat-ignore-2+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +wstat-ignore-4+ ¶

Package

purgatory.

Source

client.lisp.

Constant: +wstat-ignore-8+ ¶

Package

purgatory.

Source

client.lisp.

---

5.2.2 Special variables

Special Variable: *directory-sep* ¶

Package

purgatory.filesystem-utils.

Source

filesystem-utils.lisp.

Special Variable: *rattach* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rauth* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rclunk* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rcreate* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rerror* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rflush* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *ropen* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rread* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rremove* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rstat* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rversion* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rwalk* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rwrite* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *rwstat* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tattach* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tauth* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tclunk* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tcreate* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *terror* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tflush* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *topen* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tread* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tremove* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tstat* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *tversion* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *twalk* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *twrite* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *twstat* ¶

Package

purgatory.

Source

message-types.lisp.

Special Variable: *unix-epoch-difference* ¶

Package

purgatory.

Source

client.lisp.

---

5.2.3 Macros

Macro: defcond (type) ¶

Package

purgatory.misc-utils.

Source

misc-utils.lisp.

Macro: gen-delete@ ((sequence position) &body body) ¶

Package

purgatory.misc-utils.

Source

misc-utils.lisp.

Macro: gen-intn->bytes (bits) ¶

Package

purgatory.

Source

client.lisp.

Macro: with-callback-read-all ((recurse-function-name offset data-reply byte-count) &body body) ¶

Package

purgatory.

Source

client.lisp.

---

5.2.4 Ordinary functions

Function: %9p-walk-self (stream root-fid new-fid &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: add-size (msg) ¶

Package

purgatory.

Source

client.lisp.

Function: append-tag-callback (tag function) ¶

Package

purgatory.

Source

client.lisp.

Function: big-endian->little-endian (bytes) ¶

Package

purgatory.

Source

client.lisp.

Function: bytes->int (bytes) ¶

Convenience function to convert a vector of bytes to a number using the correct bytes order.

Package

purgatory.

Source

client.lisp.

Function: cat-reply-vector (a b) ¶

Package

purgatory.

Source

client.lisp.

Function: change-time (stream root-fid path time slot-function-name &key callback) ¶

Package

purgatory.

Source

client.lisp.

Function: close-ssl-socket (socket) ¶

Package

purgatory.

Source

client.lisp.

Function: compose-message (message-type tag &rest params) ¶

Package

purgatory.

Source

client.lisp.

Function: copy-permissions (instance) ¶

Package

purgatory.

Source

client.lisp.

Function: copy-stat (instance) ¶

Package

purgatory.

Source

client.lisp.

Function: decode-permissions (data) ¶

Package

purgatory.

Source

client.lisp.

Function: decode-quid (data) ¶

Package

purgatory.

Source

client.lisp.

Function: displace-response (response) ¶

Package

purgatory.

Source

client.lisp.

Function: encode-permissions (permissions) ¶

Package

purgatory.

Source

client.lisp.

Function: encoded-string-offset (decoded-string) ¶

Package

purgatory.

Source

client.lisp.

Function: error-response-p (response) ¶

Package

purgatory.

Source

client.lisp.

Function: exhausted-stream-for-read-p (count) ¶

Package

purgatory.

Source

client.lisp.

Function: file-type-number->symbol (key) ¶

Package

purgatory.

Source

client.lisp.

Function: fire-response (tag message-type data) ¶

Package

purgatory.

Source

client.lisp.

Function: ignore-response (tag) ¶

Package

purgatory.

Source

client.lisp.

Function: int16->bytes (val &optional count res) ¶

Package

purgatory.

Source

client.lisp.

Function: int32->bytes (val &optional count res) ¶

Package

purgatory.

Source

client.lisp.

Function: int416->bytes (val &optional count res) ¶

Package

purgatory.

Source

client.lisp.

Function: int512->bytes (val &optional count res) ¶

Package

purgatory.

Source

client.lisp.

Function: int64->bytes (val &optional count res) ¶

Package

purgatory.

Source

client.lisp.

Function: int8->bytes (val &optional count res) ¶

Package

purgatory.

Source

client.lisp.

Function: make-message-buffer (size) ¶

Package

purgatory.

Source

client.lisp.

Function: make-octects (number size) ¶

Package

purgatory.

Source

client.lisp.

Function: make-octects-permissions (mode) ¶

Package

purgatory.

Source

client.lisp.

Function: maximum-read-buffer-size () ¶

Package

purgatory.

Source

client.lisp.

Function: next-fid () ¶

Generate a fresh fid

Package

purgatory.

Source

client.lisp.

Function: next-tag () ¶

Package

purgatory.

Source

client.lisp.

Function: permissions->list (permissions) ¶

Package

purgatory.

Source

client.lisp.

Function: permissions->string (permissions) ¶

Package

purgatory.

Source

client.lisp.

Function: permissions-p (object) ¶

Package

purgatory.

Source

client.lisp.

Function: send-message (stream message) ¶

Package

purgatory.

Source

client.lisp.

Function: send-version (stream tag) ¶

Package

purgatory.

Source

client.lisp.

Function: stat-p (object) ¶

Package

purgatory.

Source

client.lisp.

Function: strcat* (chunks) ¶

Package

purgatory.text-utils.

Source

text-utils.lisp.

Function: symbol->file-type-number (key) ¶

Package

purgatory.

Source

client.lisp.

Function: tags-exists-p-clsr (tag-looking-for) ¶

Package

purgatory.

Source

client.lisp.

Function: universal->unix (universal) ¶

Package

purgatory.

Source

client.lisp.

Function: unix->universal (unix) ¶

Package

purgatory.

Source

client.lisp.

Function: vcat (a b) ¶

Package

purgatory.

Source

client.lisp.

---

5.2.5 Generic functions

Generic Function: 9p-wstat (stream fid stat &key callback) ¶

Package

purgatory.

Source

client.lisp.

Methods

Method: 9p-wstat (stream fid (stat vector) &key callback) ¶

Method: 9p-wstat (stream fid (stat stat) &key callback) ¶

Generic Reader: connection-data (condition) ¶

Package

purgatory.

Methods

Reader Method: connection-data ((condition 9p-authorization-error)) ¶

Source

conditions.lisp.

Target Slot

connection-string.

Generic Function: delete@ (sequence position) ¶

Package

purgatory.misc-utils.

Source

misc-utils.lisp.

Methods

Method: delete@ ((sequence vector) position) ¶

Method: delete@ ((sequence list) position) ¶

Generic Reader: error-value (condition) ¶

Package

purgatory.

Methods

Reader Method: error-value ((condition 9p-error)) ¶

Source

conditions.lisp.

Target Slot

error-value.

Generic Reader: idx (condition) ¶

Package

purgatory.misc-utils.

Methods

Reader Method: idx ((condition out-of-bounds)) ¶

Source

misc-utils.lisp.

Target Slot

idx.

Generic Reader: message-type (condition) ¶

Package

purgatory.

Methods

Reader Method: message-type ((condition 9p-error)) ¶

Source

conditions.lisp.

Target Slot

message-type.

Generic Function: octects= (a b) ¶

Package

purgatory.

Source

client.lisp.

Methods

Method: octects= ((a number) (b number)) ¶

Method: octects= ((a number) (b octects)) ¶

Method: octects= ((a octects) b) ¶

Generic Reader: rtag (condition) ¶

Package

purgatory.

Methods

Reader Method: rtag ((condition 9p-initialization-error)) ¶

Source

conditions.lisp.

Target Slot

rtag.

Generic Function: safe-delete@ (sequence position) ¶

Return sequence if position is out of bound

Package

purgatory.misc-utils.

Source

misc-utils.lisp.

Methods

Method: safe-delete@ ((sequence sequence) position) ¶

Generic Reader: seq (condition) ¶

Package

purgatory.misc-utils.

Methods

Reader Method: seq ((condition out-of-bounds)) ¶

Source

misc-utils.lisp.

Target Slot

seq.

Generic Reader: size (object) ¶

Package

purgatory.

Methods

Reader Method: size ((octects octects)) ¶

automatically generated reader method

Source

client.lisp.

Target Slot

size.

Generic Writer: (setf size) (object) ¶

Package

purgatory.

Methods

Writer Method: (setf size) ((octects octects)) ¶

automatically generated writer method

Source

client.lisp.

Target Slot

size.

Generic Reader: tag (condition) ¶

Package

purgatory.

Methods

Reader Method: tag ((condition 9p-initialization-error)) ¶

Source

conditions.lisp.

Target Slot

tag.

Reader Method: tag ((condition 9p-error)) ¶

Source

conditions.lisp.

Target Slot

tag.

Generic Reader: text (condition) ¶

Package

purgatory.misc-utils.

Methods

Reader Method: text ((condition text-error)) ¶

Source

misc-utils.lisp.

Target Slot

text.

Generic Reader: value (object) ¶

Package

purgatory.

Methods

Reader Method: value ((octects octects)) ¶

automatically generated reader method

Source

client.lisp.

Target Slot

value.

Generic Writer: (setf value) (object) ¶

Package

purgatory.

Methods

Writer Method: (setf value) ((octects octects)) ¶

automatically generated writer method

Source

client.lisp.

Target Slot

value.

---