The net4cl Reference Manual

Table of Contents

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

The net4cl Reference Manual

This is the net4cl Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:07:10 2018 GMT+0.


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

1 Systems

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


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

1.1 net4cl

Maintainer

Walter C. Pelissero <walter@pelissero.de>

Author

Walter C. Pelissero <walter@pelissero.de>

License

Lesser General Public License

Description

NET4CL a Common Lisp library to handle e-mail

Long Description

NET4CL is a library for Common Lisp to send e-mail via SMTP.

Dependencies
Source

net4cl.asd (file)

Component

net.lisp (file)


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

2 Files

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


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

2.1 Lisp


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

2.1.1 net4cl.asd

Location

net4cl.asd

Systems

net4cl (system)

Packages

net4cl-system


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

2.1.2 net4cl/net.lisp

Parent

net4cl (system)

Location

net.lisp

Packages

net4cl

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 net4cl-system

Source

net4cl.asd

Use List

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

3.2 net4cl

Source

net.lisp (file)

Nickname

net

Use List
Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Special variables

Special Variable: *services-file*
Package

net4cl

Source

net.lisp (file)


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

4.1.2 Macros

Macro: do-connections (SOCKET SOCKET-DESCRIPTION &key BUFFERING ELEMENT-TYPE TIMEOUT KEEP-OPEN) &body BODY
Package

net4cl

Source

net.lisp (file)

Macro: with-open-socket (SOCKET &rest ARGS) &body BODY

Execute BODY in a context where client SOCKET is bound to a connected socket made by calling OPEN-SOCKET with ARGS. Make sure to close the socket upon exit of the code block.

Package

net4cl

Source

net.lisp (file)

Macro: with-server-socket (SOCKET PORT) &body BODY

Execute BODY in a context where client SOCKET is bound to a server socket listening to PORT. Make sure to close the socket upon exit of the code block.

Package

net4cl

Source

net.lisp (file)


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

4.1.3 Functions

Function: find-service SERVICE-NAME &optional PROTOCOL

Return the port number associated to a particular service. This is looked up in /etc/services.

Package

net4cl

Source

net.lisp (file)

Function: get-address-by-hostname HOST

Return the IP address that belongs to HOST or NIL if unknown. Return a vector of type (VECTOR (UNSIGNED-BYTE 8) 4).

Package

net4cl

Source

net.lisp (file)

Function: get-host-name ()
Package

net4cl

Source

net.lisp (file)

Function: get-hostname-by-address IP-ADDR

Return the hostname associated to IP-ADDR, or NIL if unknown. IP-ADDR is supposed to be a vector of type (VECTOR (UNSIGNED-BYTE 8) 4).

Package

net4cl

Source

net.lisp (file)

Function: make-server-socket DESCRIPTION

Make a server socket based on DESCRIPTION. If it’s a string it’s a service name. If it’s a number must be a port number. If it’s a pathname it’s the Unix domain (local) socket.

Package

net4cl

Source

net.lisp (file)

Function: open-socket &key PATHNAME HOST PORT BUFFERING ELEMENT-TYPE

Return a connected socket. Either specify PATHNAME (for a Unix domain socket), or HOST and PORT, for an internet socket. Buffering is shamefully Lisp implementation dependent.

Package

net4cl

Source

net.lisp (file)

Function: parse-ip-address STRING
Package

net4cl

Source

net.lisp (file)


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

4.1.4 Generic functions

Generic Function: accept SERVER-SOCKET &key ELEMENT-TYPE BUFFERING TIMEOUT
Package

net4cl

Source

net.lisp (file)

Methods
Method: accept (SERVER-SOCKET server-socket) &key ELEMENT-TYPE BUFFERING TIMEOUT
Generic Function: close-socket SOCKET &key ABORT
Package

net4cl

Source

net.lisp (file)

Methods
Method: close-socket (SOCKET connected-socket) &key ABORT
Method: close-socket (SOCKET unix-server-socket) &key ABORT
Method: close-socket (SOCKET socket) &key ABORT
Generic Function: socket-real-socket OBJECT
Package

net4cl

Methods
Method: socket-real-socket (SOCKET socket)

System specific socket object.

Source

net.lisp (file)

Generic Function: socket-stream OBJECT
Package

net4cl

Methods
Method: socket-stream (CONNECTED-SOCKET connected-socket)

System specific stream object of socket.

Source

net.lisp (file)


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

4.2 Internal definitions


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

4.2.1 Special variables

Special Variable: +whitespace-chars+
Package

net4cl

Source

net.lisp (file)


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

4.2.2 Functions

Function: close-real-server-socket SOCKET
Package

net4cl

Source

net.lisp (file)

Function: close-real-socket SOCKET

Close a system specific socket. Not the class defined in this module.

Package

net4cl

Source

net.lisp (file)

Function: open-inet-socket HOST PORT BUFFERING ELEMENT-TYPE

Open a TCP socket to HOST at PORT.

Package

net4cl

Source

net.lisp (file)

Function: open-local-socket PATHNAME BUFFERING ELEMENT-TYPE
Package

net4cl

Source

net.lisp (file)


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

4.2.3 Generic functions

Generic Function: socket-pathname OBJECT
Generic Function: (setf socket-pathname) NEW-VALUE OBJECT
Package

net4cl

Methods
Method: socket-pathname (UNIX-SERVER-SOCKET unix-server-socket)
Method: (setf socket-pathname) NEW-VALUE (UNIX-SERVER-SOCKET unix-server-socket)

Pathname of the Unix domain slocket.

Source

net.lisp (file)

Generic Function: socket-status OBJECT
Package

net4cl

Methods
Method: socket-status (SOCKET socket)

Current status of socket. When newly created it’s :OPEN. It becomes :CLOSED after a CLOSE-SOCKET.

Source

net.lisp (file)


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

4.2.4 Classes

Class: connected-socket ()
Package

net4cl

Source

net.lisp (file)

Direct superclasses

socket (class)

Direct methods
Direct slots
Slot: stream

System specific stream object of socket.

Initargs

:stream

Readers

socket-stream (generic function)

Class: inet-server-socket ()
Package

net4cl

Source

net.lisp (file)

Direct superclasses

server-socket (class)

Class: server-socket ()
Package

net4cl

Source

net.lisp (file)

Direct superclasses

socket (class)

Direct subclasses
Direct methods

accept (method)

Class: socket ()
Package

net4cl

Source

net.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: real-socket

System specific socket object.

Initargs

:socket

Readers

socket-real-socket (generic function)

Slot: status

Current status of socket. When newly created it’s :OPEN. It becomes :CLOSED after a CLOSE-SOCKET.

Type

(member :open :closed)

Initargs

:status

Initform

:open

Readers

socket-status (generic function)

Class: unix-server-socket ()
Package

net4cl

Source

net.lisp (file)

Direct superclasses

server-socket (class)

Direct methods
Direct slots
Slot: pathname

Pathname of the Unix domain slocket.

Initargs

:pathname

Readers

socket-pathname (generic function)

Writers

(setf socket-pathname) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   N  
Index Entry  Section

F
File, Lisp, net4cl.asd: The net4cl<dot>asd file
File, Lisp, net4cl/net.lisp: The net4cl/net<dot>lisp file

L
Lisp File, net4cl.asd: The net4cl<dot>asd file
Lisp File, net4cl/net.lisp: The net4cl/net<dot>lisp file

N
net4cl.asd: The net4cl<dot>asd file
net4cl/net.lisp: The net4cl/net<dot>lisp file

Jump to:   F   L   N  

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

A.2 Functions

Jump to:   (  
A   C   D   F   G   M   O   P   S   W  
Index Entry  Section

(
(setf socket-pathname): Internal generic functions
(setf socket-pathname): Internal generic functions

A
accept: Exported generic functions
accept: Exported generic functions

C
close-real-server-socket: Internal functions
close-real-socket: Internal functions
close-socket: Exported generic functions
close-socket: Exported generic functions
close-socket: Exported generic functions
close-socket: Exported generic functions

D
do-connections: Exported macros

F
find-service: Exported functions
Function, close-real-server-socket: Internal functions
Function, close-real-socket: Internal functions
Function, find-service: Exported functions
Function, get-address-by-hostname: Exported functions
Function, get-host-name: Exported functions
Function, get-hostname-by-address: Exported functions
Function, make-server-socket: Exported functions
Function, open-inet-socket: Internal functions
Function, open-local-socket: Internal functions
Function, open-socket: Exported functions
Function, parse-ip-address: Exported functions

G
Generic Function, (setf socket-pathname): Internal generic functions
Generic Function, accept: Exported generic functions
Generic Function, close-socket: Exported generic functions
Generic Function, socket-pathname: Internal generic functions
Generic Function, socket-real-socket: Exported generic functions
Generic Function, socket-status: Internal generic functions
Generic Function, socket-stream: Exported generic functions
get-address-by-hostname: Exported functions
get-host-name: Exported functions
get-hostname-by-address: Exported functions

M
Macro, do-connections: Exported macros
Macro, with-open-socket: Exported macros
Macro, with-server-socket: Exported macros
make-server-socket: Exported functions
Method, (setf socket-pathname): Internal generic functions
Method, accept: Exported generic functions
Method, close-socket: Exported generic functions
Method, close-socket: Exported generic functions
Method, close-socket: Exported generic functions
Method, socket-pathname: Internal generic functions
Method, socket-real-socket: Exported generic functions
Method, socket-status: Internal generic functions
Method, socket-stream: Exported generic functions

O
open-inet-socket: Internal functions
open-local-socket: Internal functions
open-socket: Exported functions

P
parse-ip-address: Exported functions

S
socket-pathname: Internal generic functions
socket-pathname: Internal generic functions
socket-real-socket: Exported generic functions
socket-real-socket: Exported generic functions
socket-status: Internal generic functions
socket-status: Internal generic functions
socket-stream: Exported generic functions
socket-stream: Exported generic functions

W
with-open-socket: Exported macros
with-server-socket: Exported macros

Jump to:   (  
A   C   D   F   G   M   O   P   S   W  

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

A.3 Variables

Jump to:   *   +  
P   R   S  
Index Entry  Section

*
*services-file*: Exported special variables

+
+whitespace-chars+: Internal special variables

P
pathname: Internal classes

R
real-socket: Internal classes

S
Slot, pathname: Internal classes
Slot, real-socket: Internal classes
Slot, status: Internal classes
Slot, stream: Internal classes
Special Variable, *services-file*: Exported special variables
Special Variable, +whitespace-chars+: Internal special variables
status: Internal classes
stream: Internal classes

Jump to:   *   +  
P   R   S  

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

A.4 Data types

Jump to:   C   I   N   P   S   U  
Index Entry  Section

C
Class, connected-socket: Internal classes
Class, inet-server-socket: Internal classes
Class, server-socket: Internal classes
Class, socket: Internal classes
Class, unix-server-socket: Internal classes
connected-socket: Internal classes

I
inet-server-socket: Internal classes

N
net4cl: The net4cl system
net4cl: The net4cl package
net4cl-system: The net4cl-system package

P
Package, net4cl: The net4cl package
Package, net4cl-system: The net4cl-system package

S
server-socket: Internal classes
socket: Internal classes
System, net4cl: The net4cl system

U
unix-server-socket: Internal classes

Jump to:   C   I   N   P   S   U