The s-sysdeps Reference Manual

This is the s-sysdeps Reference Manual, version 2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:12:40 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 s-sysdeps

An abstraction layer over platform dependent functionality

Maintainer

Sven Van Caekenberghe <>

Author

Sven Van Caekenberghe <>

License

Lesser Lisp General Public License (LLGPL)

Long Description

An abstraction layer over platform dependent functionality

Version

2

Dependencies
  • usocket (system).
  • usocket-server (system).
  • bordeaux-threads (system).
Source

s-sysdeps.asd.

Child Component

src (module).


3 Modules

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


3.1 s-sysdeps/src

Source

s-sysdeps.asd.

Parent Component

s-sysdeps (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 s-sysdeps/s-sysdeps.asd

Source

s-sysdeps.asd.

Parent Component

s-sysdeps (system).

ASDF Systems

s-sysdeps.


4.1.2 s-sysdeps/src/package.lisp

Source

s-sysdeps.asd.

Parent Component

src (module).

Packages

s-sysdeps.


4.1.3 s-sysdeps/src/sysdeps.lisp

Source

s-sysdeps.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 s-sysdeps

S-SYSDEPS is an abstraction layer over platform dependent functionality

Source

package.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: with-process-lock ((lock) &body body)

Execute body wih the process lock grabbed, wait otherwise

Package

s-sysdeps.

Source

sysdeps.lisp.


6.1.2 Ordinary functions

Function: all-processes ()

Return a list of all processes currently running

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: current-process ()

Return the object representing the current process

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: get-socket-stream-property (socket-stream property)

Get the value of a socket stream property, one of :remote-host :remote-port :local-host :local-port

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: kill-process (process)

Kill the process represented by the object process

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: make-process-lock (name)

Create a named process lock object

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: multiprocessing-capable-p ()

Returns t when this implementation is multiprocessing capable

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: open-socket-stream (host port &key connect-timeout read-timeout write-timeout)

Create and open a bidirectional client TCP/IP socket stream to host:port

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: run-process (name function &rest arguments)

Create and run a new process with name, executing function on arguments

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: start-standard-server (&key port name connection-handler)

Start a server process with name, listening on port, delegating to connection-handler with stream as argument

Package

s-sysdeps.

Source

sysdeps.lisp.

Function: stop-process (name)

Stop a named process by destroying it

Package

s-sysdeps.

Source

sysdeps.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables