The s-sysdeps Reference Manual

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

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 Mon Aug 15 05:48:05 2022 GMT+0.

Table of Contents


1 Introduction

S-SYSDEPS

An Abstraction Layer Over Platform Dependent Functionality

S-SYSDEPS is an abstraction layer over platform dependent functionality. This simple package is used as a building block in a number of other open source projects.

Contents

Features

S-SYSDEPS abstracts:

Status

S-SYSDEPS is considered stable code.

News

November 2005 - Created as a seperate project.

Platforms

S-SYSDEPS is, by definition, written in ANSI standard Common Lisp but implemented using non-standard extensions. At the moment, ports for LispWorks (reference), OpenMCL, CMUCL and SBCL exist. Some other CL implementations are partially supported.

Installation

The S-SYSDEPS package is loaded using ASDF. There is an excellent tutorial on ASDF to get you started.

CL-USER 1 > (asdf:oos 'asdf:load-op :s-sysdeps)

Example of setting up and using ASDF to compile and load the package

Usage

For usage examples please have a look at the package using S-SYSDEPS.

API Reference

There is automatically generated API Reference documentation available for the S-SYSDEPS package.

Mailinglist

There is no mailing list for this project.

Changelog

Release Notes:

TODO

FAQ

Nothing appropriate.

Bugs

There are no known bugs.

Authors

S-SYSDEPS was written by Sven Van Caekenberghe. Ports to CMUCL and SBCL were contributed.

Maintainers

S-SYSDEPS is being maintained by Sven Van Caekenberghe.

License

You are granted the rights to distribute and use this software as governed by the terms of the Lisp Lesser General Public License (http://opensource.franz.com/preamble.html), also known as the LLGPL.

History

This file was part of S-XML-RPC and (N)KPAX.

References

There are no references.

Copyright © 2004-2005 Sven Van Caekenberghe, Beta Nine BVBA. All Right Reserved


2 Systems

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


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

2.1 s-sysdeps

An abstraction layer over platform dependent functionality

Maintainer

Sven Van Caekenberghe <svc@mac.com>

Author

Sven Van Caekenberghe <svc@mac.com>

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.


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

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.


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

4.1 Lisp


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

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.


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

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.


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

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.


Previous: , Up: Public Interface   [Contents][Index]

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


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

A.1 Concepts


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

A.3 Variables