The s-sysdeps Reference Manual

Table of Contents

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

The s-sysdeps Reference Manual

This is the s-sysdeps Reference Manual, version 1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:32:26 2018 GMT+0.


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

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


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

2 Systems

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


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

2.1 s-sysdeps

Maintainer

Sven Van Caekenberghe <svc@mac.com>

Author

Sven Van Caekenberghe <svc@mac.com>

License

Lesser Lisp General Public License (LLGPL)

Description

An abstraction layer over platform dependent functionality

Long Description

An abstraction layer over platform dependent functionality

Version

1

Source

s-sysdeps.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 s-sysdeps/src

Parent

s-sysdeps (system)

Location

src/

Components

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

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 files   [Contents][Index]

4.1.1 s-sysdeps.asd

Location

s-sysdeps.asd

Systems

s-sysdeps (system)


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

4.1.2 s-sysdeps/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

s-sysdeps


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

4.1.3 s-sysdeps/src/sysdeps.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/sysdeps.lisp

Exported Definitions
Internal Definitions

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

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 (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: all-processes ()

Return a list of all processes currently running

Package

s-sysdeps

Source

sysdeps.lisp (file)

Function: current-process ()

Return the object representing the current process

Package

s-sysdeps

Source

sysdeps.lisp (file)

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 (file)

Function: kill-process PROCESS

Kill the process represented by the object process

Package

s-sysdeps

Source

sysdeps.lisp (file)

Function: make-process-lock NAME

Create a named process lock object

Package

s-sysdeps

Source

sysdeps.lisp (file)

Function: multiprocessing-capable-p ()

Returns t when this implementation is multiprocessing capable

Package

s-sysdeps

Source

sysdeps.lisp (file)

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 (file)

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 (file)

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 (file)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *server-processes*

The list of processes created by S-SYSDEPS

Package

s-sysdeps

Source

sysdeps.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: stop-server NAME

Stop a named server

Package

s-sysdeps

Source

sysdeps.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   S  
Index Entry  Section

F
File, Lisp, s-sysdeps.asd: The s-sysdeps<dot>asd file
File, Lisp, s-sysdeps/src/package.lisp: The s-sysdeps/src/package<dot>lisp file
File, Lisp, s-sysdeps/src/sysdeps.lisp: The s-sysdeps/src/sysdeps<dot>lisp file

L
Lisp File, s-sysdeps.asd: The s-sysdeps<dot>asd file
Lisp File, s-sysdeps/src/package.lisp: The s-sysdeps/src/package<dot>lisp file
Lisp File, s-sysdeps/src/sysdeps.lisp: The s-sysdeps/src/sysdeps<dot>lisp file

M
Module, s-sysdeps/src: The s-sysdeps/src module

S
s-sysdeps.asd: The s-sysdeps<dot>asd file
s-sysdeps/src: The s-sysdeps/src module
s-sysdeps/src/package.lisp: The s-sysdeps/src/package<dot>lisp file
s-sysdeps/src/sysdeps.lisp: The s-sysdeps/src/sysdeps<dot>lisp file

Jump to:   F   L   M   S  

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

A.2 Functions

Jump to:   A   C   F   G   K   M   O   R   S   W  
Index Entry  Section

A
all-processes: Exported functions

C
current-process: Exported functions

F
Function, all-processes: Exported functions
Function, current-process: Exported functions
Function, get-socket-stream-property: Exported functions
Function, kill-process: Exported functions
Function, make-process-lock: Exported functions
Function, multiprocessing-capable-p: Exported functions
Function, open-socket-stream: Exported functions
Function, run-process: Exported functions
Function, start-standard-server: Exported functions
Function, stop-server: Internal functions

G
get-socket-stream-property: Exported functions

K
kill-process: Exported functions

M
Macro, with-process-lock: Exported macros
make-process-lock: Exported functions
multiprocessing-capable-p: Exported functions

O
open-socket-stream: Exported functions

R
run-process: Exported functions

S
start-standard-server: Exported functions
stop-server: Internal functions

W
with-process-lock: Exported macros

Jump to:   A   C   F   G   K   M   O   R   S   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*server-processes*: Internal special variables

S
Special Variable, *server-processes*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, s-sysdeps: The s-sysdeps package

S
s-sysdeps: The s-sysdeps system
s-sysdeps: The s-sysdeps package
System, s-sysdeps: The s-sysdeps system

Jump to:   P   S