The fsocket Reference Manual

Table of Contents

The fsocket Reference Manual

This is the fsocket Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:47:31 2022 GMT+0.

1 Introduction

fsocket

1. Introduction

This is yet-another Common Lisp FFI to provide a portable sockets API. It is intended to offer a socket API that wraps at a very low level the underlying BSD-sockets API provided by the host OS. Only supports the standard blocking I/O calls, does not support overlapped or aio_ type asynchronous calls.

2. Usage

Basically you write exactly the same sort of code you would if writing in C.

2.1 Socket functions

• OPEN-SOCKET :: open a socket.
• CLOSE-SOCKET :: close a socket.
• SOCKET-SHUTDOWN :: graceful shutdown of a connected socket.
• SOCKET-BIND :: bind to local address.
• SOCKET-LISTEN :: listen for connections.
• SOCKET-CONNECT :: connect to remote server.
• SOCKET-ACCEPT :: accept connection, returns connected socket.
• SOCKET-NAME :: get local address of bound socket.
• SOCKET-OPTION :: get a socket option.
• (SETF SOCKET-OPTION) :: set a socket option.

;; open the socket 
(let ((fd (open-socket :type :datagram)))
  (socket-bind fd (make-sockaddr-in))
  ;; do something with the socket 

  ;; close it
  (close-socket fd))

2.2 Socket I/O

There are two types of I/O: send/recv for connected sockets and sendto/recvfrom for unconnected sockets.

• SOCKET-SEND :: send a buffer on a connected socket.
• SOCKET-SENDTO :: send a buffer on an unconnected socket.
• SOCKET-RECV :: receive on a connected socket.
• SOCKET-RECVFROM :: receive on an unconnected socket.

(let ((fd (open-socket :type :datagram))
      (buffer (make-array 1024)))
  (socket-bind fd (make-sockaddr-in :port 9000))
  (multiple-value-bind (count raddr) (socket-recvfrom fd buffer)
    (format t "Received ~A bytes from ~A~%" count raddr)
    (socket-sendto fd buffer raddr :end count))
  
  (close-socket fd))

The 4 I/O functions also accept a foreign pointer instead of an octet vector as the buffer parameter. This allows callers to avoid the copy to and from foreign memory. This is somewhat more awkward to use but for certain applications could prove useful.

2.3 Polling

Provides an API based on POSIX poll(). On systems where this is available (i.e. everywhere except Windows) it calls directly to poll(). On Windows it calls WSAEnumNetworkEvents() and iterates over each socket. The Windows events are mapped to poll events.

• OPEN-POLL :: open a polling context.
• CLOSE-POLL :: close a polling context.
• POLL-REGISTER :: register a socket with the poll context.
• POLL-UNREGISTER :: unregister a socket from the poll context.
• POLL :: wait for something to happen.
• DOEVENTS :: iterate over each of the fds with events pending.

(let ((pc (open-poll)))
  (poll-register pc (make-instance 'pollfd :fd fd :events (poll-events :pollin)))
  (doevents (pollfd event) (poll pc :timeout 1000)
    ;; process the events
    )
  (close-poll pc))

2.4 Hardware adapters

• LIST-ADAPTERS :: list host adapters, returns a list of ADAPTER structures.

These contain a list of IP addresses associated with the adapter (i.e. logical interfaces), the physical address of the adapter, the interface index and current status.

3. Socket options

The currently supported socket options are as follows.

Socket options :SOCKET

• SO_ACCEPTCONN :ACCEPTCONN boolean
• SO_BROADCAST :BROADCAST boolean
• SO_REUSEADDR :REUSEADDR boolean
• SO_SNDBUF :SNDBUF integer
• SO_RCVBUF :RCVBUF integer
• SO_SNDTIMEO :SNDTIMEO integer
• SO_RCVTIMEO :RCVTIMEO integer

IP options :IP

• IP_MULTICAST_LOOP :IP-MULTICAST-LOOP boolean
• IP_MULTICAST_IF :IP-MULTICAST-IF 4-octet array
• IP_MULTICAST_TTL :IP_MULTICAST_TTL integer
• MCAST_JOIN_GROUP :MCAST-JOIN-GROUP (index addr) where index is the interface index and addr is the multicast address

TCP options :TCP

• TCP_NODELAY :NODELAY boolean

4. Advanced topics

Various advanced usage topics here.

4.1 Polling

FSOCKET provides a portable polling mechanism based on POSIX poll(). On those systems is calls poll() directly, but on Windows we need a little bit more work. In order to provide a uniform interface on all platforms we must do the following:

1. Allocate a poll context. On Windows this calls WSACreateEvent(). On POSIX it does nothing.
2. For each socket you wish to poll, call POLL-REGISTER. On Windows this calls WSAEventSelect(). This associates a POLLFD instance (which encapsulates the socket) with the poll context.
3. Call POLL. On Windows this calls WSAWaitForMultipleEvents() and then WSAEnumNetworkEvents() for each socket. On POSIX it simply calls poll().
4. Iterate over each of the input POLLFD descriptors and process the pending events.

4.1.1 Side-effects of POLL-REGISTER

• On Windows, POLL-REGISTER calls WSAEventSelect, which will convert the socket to non-blocking mode.
• On POSIX systes POLL-REGISTER does nothing other than pushing the pollfd instance onto a list of pollfds stored with the poll context.
• To preserve semantics, in posix systems the socket is put into non-blocking mode by calling fcntl()
• Therefore users should be aware that once they have registered with the poll context, the socket will now be in non-blocking mode.

4.2 IP multicast

IPv4 UDP multicast is implemented and working. See test/test2.lisp.

• MULTICAST-JOIN ::= join the socket to the multicast group on all ethernet interfaces.
• OPEN-MULTICAST-SOCKET ::= open a socket to send multicast datagrams.

4.3 Subclassing POLLFD

When you call POLL-REGISTER you provide an instance of the class POLLFD, which encapsulates the socket and the events you wish to poll for. However, typically you will also want to associate other information with the socket, for instance and receive buffer or other contextual information. All you have to do is subclass POLLFD and provide instances of your own class to POLL-REGISTER. For an example see TCP-ECHO in test/test1.lisp where I provide different subclasses for the listening TCP socket and its connections.

4.4 UDP broadcast

There can be issues when performing UDP broadcast to address 255.255.255.255 on FreeBSD. This is due to the way FreeBSD implements UDP broadcasting, which is different to Linux and Windows in this respect.

4.5 Unix Domain sockets

On POSIX platforms (for fsocket, that means Linux, FreeBSD, Darwin i.e. everywhere but Windows) unix domain sockets are also supported as a family :UNIX to OPEN-SOCKET. Currently only :STREAM type sockets are supported, datagram type unix domain sockets may be supported at some point in the future. Unlike :INET and :INET6 families, :UNIX sockets are addressed using a string which represents a file on the host. Otherwise their usage is the same. See test/test-unix.lisp for an example.

4.6 Linux CAN Sockets

On Linux platforms the BSD-sockets are extended by a SocketCAN API, which implements communication between a host OS and a CAN bus. An application reads and sends CAN messages using SOCKET-RECV, SOCKET-RECVFROM, SOCKET-SEND and SOCKET-SENDTO after a corresponding file descriptor is created (OPEN-SOCKET) and bound (SOCKET-BIND). It is recommended to use the macro WITH-CAN-SOCKET to safely open, bind and close CAN sockets. All SocketCAN SEND* operations never block, all SocketCAN RECV* calls always block. Use polling to make the latter non-blocking. Some useful examples can be found in test/test-socketcan.lisp.

5. Implementations and operatings systems

Because we are calling directly into the host API using CFFI, the implementation portability issues are handled by CFFI. I intend to support Windows, Linux, FreeBSD and OSX. Currently the following have been tested. A small amount of work will be required to support other systems (e.g. checking structs have the same layout, adjusting constants etc.).

• Tested: SBCL x86-64 1.2.11 Windows 7
• Tested: SBCL x86-64 1.2.9 FreeBSD-10.2
• Tested: SBCL x86 1.2.7 Linux
• Tested: LispWorks Personal Edition 6.1.1 Windows 8.1
• Tested: CCL x86-64 1.11 OSX
• TODO: CCL (Windows, Linux, FreeBSD)
• TODO: arch other than x86 or x86-64.
• TODO: others

6. TODO

• [x] Type all the stuff in for POSIX systems (Linux,FreeBSD)
• [x] LIST-ADAPTERS
• [ ] Write a whole suite of tests to check it all works
• [x] Write something non-trivial using it to make sure it has a sane API
• [ ] Support raw sockets? Unlikely to happen anytime soon.
• [x] Unix domain sockets

7. License

Licensed under the terms of the MIT license. Frank James 2015.

2 Systems

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

2.1 fsocket

Author

Frank James <frank.a.james@gmail.com>

License

MIT

Description

Franks socket API

Dependencies

• cffi
• trivial-gray-streams

Source

fsocket.asd (file)

Components

• package.lisp (file)
• errors.lisp (file)
• constants.lisp (file)
• common.lisp (file)
• posix.lisp (file)
• options.lisp (file)
• streams.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 fsocket.asd

Location

fsocket.asd

Systems

fsocket (system)

3.1.2 fsocket/package.lisp

Parent

fsocket (system)

Location

package.lisp

Packages

fsocket

3.1.3 fsocket/errors.lisp

Dependency

package.lisp (file)

Parent

fsocket (system)

Location

errors.lisp

Exported Definitions

• fsocket-error (condition)
• fsocket-short-buffer (condition)

Internal Definitions

fsocket-error-msg (method)

3.1.4 fsocket/constants.lisp

Dependency

errors.lisp (file)

Parent

fsocket (system)

Location

constants.lisp

Internal Definitions

• +af-inet+ (constant)
• +af-inet6+ (constant)
• +af-unix+ (constant)
• +can-raw+ (constant)
• +ip-multicast-if+ (constant)
• +ip-multicast-loop+ (constant)
• +ip-multicast-ttl+ (constant)
• +ip6-multicast-if+ (constant)
• +ip6-multicast-loop+ (constant)
• +ipproto-ip+ (constant)
• +ipproto-ip6+ (constant)
• +ipproto-tcp+ (constant)
• +ipproto-udp+ (constant)
• +ipv6-multicast-hops+ (constant)
• +mcast-join-group+ (constant)
• +pf-can+ (constant)
• +siocgifindex+ (constant)
• +siocgifname+ (constant)
• +siocgstamp+ (constant)
• +so-acceptconn+ (constant)
• +so-broadcast+ (constant)
• +so-error+ (constant)
• +so-rcvbuf+ (constant)
• +so-rcvtimeo+ (constant)
• +so-reuseaddr+ (constant)
• +so-sndbuf+ (constant)
• +so-sndtimeo+ (constant)
• +sock-dgram+ (constant)
• +sock-raw+ (constant)
• +sock-stream+ (constant)
• +sol-socket+ (constant)
• +tcp-nodelay+ (constant)

3.1.5 fsocket/common.lisp

Dependency

constants.lisp (file)

Parent

fsocket (system)

Location

common.lisp

Exported Definitions

• adapter (structure)
• adapter-address (function)
• (setf adapter-address) (function)
• adapter-broadcast (function)
• (setf adapter-broadcast) (function)
• adapter-index (function)
• (setf adapter-index) (function)
• adapter-mtu (function)
• (setf adapter-mtu) (function)
• adapter-name (function)
• (setf adapter-name) (function)
• adapter-netmask (function)
• (setf adapter-netmask) (function)
• adapter-status (function)
• (setf adapter-status) (function)
• adapter-type (function)
• (setf adapter-type) (function)
• adapter-unicast (function)
• (setf adapter-unicast) (function)
• doevents (macro)
• loopback-p (function)
• make-can-interface (function)
• make-can-packet (function)
• make-sockaddr-in (function)
• make-sockaddr-in6 (function)
• parse-can-packet (function)
• poll-event (function)
• poll-event-p (function)
• poll-events (function)
• pollfd (class)
• pollfd-events (method)
• (setf pollfd-events) (method)
• pollfd-fd (method)
• (setf pollfd-fd) (method)
• pollfd-revents (method)
• (setf pollfd-revents) (method)
• sockaddr-in (function)
• sockaddr-in (structure)
• sockaddr-in-addr (function)
• (setf sockaddr-in-addr) (function)
• sockaddr-in-p (function)
• sockaddr-in-port (function)
• (setf sockaddr-in-port) (function)
• sockaddr-in6 (function)
• sockaddr-in6 (structure)
• sockaddr-in6-addr (function)
• (setf sockaddr-in6-addr) (function)
• sockaddr-in6-p (function)
• sockaddr-in6-port (function)
• (setf sockaddr-in6-port) (function)
• sockaddr-string (function)
• sockaddr= (function)
• string-sockaddr (function)
• with-poll (macro)
• with-socket (macro)
• with-tcp-connection (macro)
• with-tcp-socket (macro)
• with-udp-socket (macro)

Internal Definitions

• %read (function)
• %write (function)
• adapter-p (function)
• can-interface (structure)
• can-interface-name (function)
• (setf can-interface-name) (function)
• can-interface-p (function)
• can-packet (structure)
• can-packet-data (function)
• (setf can-packet-data) (function)
• can-packet-id (function)
• (setf can-packet-id) (function)
• can-packet-origin (function)
• (setf can-packet-origin) (function)
• can-packet-p (function)
• can-packet-timestamp (function)
• (setf can-packet-timestamp) (function)
• copy-adapter (function)
• copy-can-interface (function)
• copy-can-packet (function)
• copy-sockaddr-in (function)
• copy-sockaddr-in6 (function)
• dotted-quad-p (function)
• dotted-quad-to-inaddr (function)
• htonl (function)
• htons (function)
• inaddr-to-dotted-quad (function)
• make-adapter (function)
• ntohs (function)
• sockaddr-in-tclass (class)
• sockaddr-in6-flowinfo (function)
• (setf sockaddr-in6-flowinfo) (function)
• sockaddr-in6-scopeid (function)
• (setf sockaddr-in6-scopeid) (function)
• sockaddr-in6-tclass (class)
• sockaddr-un-tclass (class)
• translate-sockaddr-family (function)
• translate-sockaddr-from-foreign (function)

3.1.6 fsocket/posix.lisp

Dependency

common.lisp (file)

Parent

fsocket (system)

Location

posix.lisp

Exported Definitions

• close-poll (function)
• close-socket (function)
• get-host-name (function)
• get-name-servers (function)
• list-adapters (function)
• open-poll (function)
• open-socket (function)
• poll (function)
• poll-context (structure)
• poll-context-fds (function)
• (setf poll-context-fds) (function)
• poll-find (function)
• poll-register (function)
• poll-unregister (function)
• socket-accept (function)
• socket-bind (function)
• socket-connect (function)
• socket-listen (function)
• socket-name (function)
• socket-peer (function)
• socket-recv (function)
• socket-recvfrom (function)
• socket-send (function)
• socket-sendto (function)
• socket-shutdown (function)
• with-can-socket (macro)

Internal Definitions

• %accept (function)
• %bind (function)
• %close (function)
• %connect (function)
• %fcntl (function)
• %freeifaddrs (function)
• %get-domain-name (function)
• %get-host-name (function)
• %getifaddrs (function)
• %getpeername (function)
• %getsockname (function)
• %getsockopt (function)
• %if-nametoindex (function)
• %ioctl (function)
• %listen (function)
• %poll (function)
• %recv (function)
• %recvfrom (function)
• %res-ndestroy (function)
• %res-ninit (function)
• %send (function)
• %sendto (function)
• %setsockopt (function)
• %shutdown-socket (function)
• %socket (function)
• %var-accessor-*errno* (function)
• (setf %var-accessor-*errno*) (function)
• *errno* (symbol macro)
• +arphrd-80211+ (constant)
• +arphrd-ether+ (constant)
• +arphrd-loopback+ (constant)
• +arphrd-ppp+ (constant)
• +einprogress+ (constant)
• +ewouldblock+ (constant)
• +f-getfl+ (constant)
• +f-setfl+ (constant)
• +fionbio+ (constant)
• +iff-loopback+ (constant)
• +iff-up+ (constant)
• +o-nonblock+ (constant)
• +siocgifbrdaddr+ (constant)
• +siocgifhwaddr+ (constant)
• +siocgifmtu+ (constant)
• +siocgifnetmask+ (constant)
• +sockaddr-storage+ (constant)
• +socket-error+ (constant)
• +syscall-error+ (constant)
• can-frame-tclass (class)
• copy-poll-context (function)
• get-last-error (function)
• ifaddrs-tclass (class)
• ifmap-tclass (class)
• ifreq-tclass (class)
• invalid-socket-p (function)
• make-poll-context (function)
• poll-context-p (function)
• pollfd-tclass (class)
• posix-error (condition)
• posix-error-code (method)
• res-state-tclass (class)
• set-nonblocking (function)
• sockaddr-can-tclass (class)
• socket-flags (function)
• (setf socket-flags) (function)
• strerror (function)
• tp-tclass (class)
• with-syscall-else-error (macro)

3.1.7 fsocket/options.lisp

Dependency

posix.lisp (file)

Parent

fsocket (system)

Location

options.lisp

Exported Definitions

• multicast-join (function)
• open-multicast-socket (function)
• open-tcp-connection (function)
• open-tcp-socket (function)
• open-udp-socket (function)
• socket-option (generic function)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• (setf socket-option) (generic function)
• (setf socket-option) (method)
• (setf socket-option) (method)
• (setf socket-option) (method)
• (setf socket-option) (method)

Internal Definitions

• get-socket-option-boolean (function)
• get-socket-option-int32 (function)
• get-socket-option-uint32 (function)
• group-req-tclass (class)
• set-socket-option-boolean (function)
• set-socket-option-int32 (function)
• set-socket-option-pointer (function)
• set-socket-option-uint32 (function)
• timeval-tclass (class)

3.1.8 fsocket/streams.lisp

Dependency

options.lisp (file)

Parent

fsocket (system)

Location

streams.lisp

Exported Definitions

• make-tcp-stream (function)
• tcp-stream (class)

Internal Definitions

• tcp-stream-fd (method)
• with-tcp-stream (macro)

4 Packages

Packages are listed by definition order.

4.1 fsocket

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• adapter (structure)
• adapter-address (function)
• (setf adapter-address) (function)
• adapter-broadcast (function)
• (setf adapter-broadcast) (function)
• adapter-index (function)
• (setf adapter-index) (function)
• adapter-mtu (function)
• (setf adapter-mtu) (function)
• adapter-name (function)
• (setf adapter-name) (function)
• adapter-netmask (function)
• (setf adapter-netmask) (function)
• adapter-status (function)
• (setf adapter-status) (function)
• adapter-type (function)
• (setf adapter-type) (function)
• adapter-unicast (function)
• (setf adapter-unicast) (function)
• close-poll (function)
• close-socket (function)
• doevents (macro)
• fsocket-error (condition)
• fsocket-short-buffer (condition)
• get-host-name (function)
• get-name-servers (function)
• list-adapters (function)
• loopback-p (function)
• make-can-interface (function)
• make-can-packet (function)
• make-sockaddr-in (function)
• make-sockaddr-in6 (function)
• make-tcp-stream (function)
• multicast-join (function)
• open-multicast-socket (function)
• open-poll (function)
• open-socket (function)
• open-tcp-connection (function)
• open-tcp-socket (function)
• open-udp-socket (function)
• parse-can-packet (function)
• poll (function)
• poll-context (structure)
• poll-context-fds (function)
• (setf poll-context-fds) (function)
• poll-event (function)
• poll-event-p (function)
• poll-events (function)
• poll-find (function)
• poll-register (function)
• poll-unregister (function)
• pollfd (class)
• pollfd-events (generic function)
• pollfd-events (method)
• (setf pollfd-events) (method)
• (setf pollfd-events) (generic function)
• pollfd-fd (generic function)
• pollfd-fd (method)
• (setf pollfd-fd) (method)
• (setf pollfd-fd) (generic function)
• pollfd-revents (generic function)
• pollfd-revents (method)
• (setf pollfd-revents) (method)
• (setf pollfd-revents) (generic function)
• sockaddr-in (function)
• sockaddr-in (structure)
• sockaddr-in-addr (function)
• (setf sockaddr-in-addr) (function)
• sockaddr-in-p (function)
• sockaddr-in-port (function)
• (setf sockaddr-in-port) (function)
• sockaddr-in6 (function)
• sockaddr-in6 (structure)
• sockaddr-in6-addr (function)
• (setf sockaddr-in6-addr) (function)
• sockaddr-in6-p (function)
• sockaddr-in6-port (function)
• (setf sockaddr-in6-port) (function)
• sockaddr-string (function)
• sockaddr= (function)
• socket-accept (function)
• socket-bind (function)
• socket-connect (function)
• socket-listen (function)
• socket-name (function)
• socket-option (generic function)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• socket-option (method)
• (setf socket-option) (method)
• (setf socket-option) (generic function)
• (setf socket-option) (method)
• (setf socket-option) (method)
• (setf socket-option) (method)
• (setf socket-option) (method)
• socket-peer (function)
• socket-recv (function)
• socket-recvfrom (function)
• socket-send (function)
• socket-sendto (function)
• socket-shutdown (function)
• string-sockaddr (function)
• tcp-stream (class)
• with-can-socket (macro)
• with-poll (macro)
• with-socket (macro)
• with-tcp-connection (macro)
• with-tcp-socket (macro)
• with-udp-socket (macro)

Internal Definitions

• %accept (function)
• %bind (function)
• %close (function)
• %connect (function)
• %fcntl (function)
• %freeifaddrs (function)
• %get-domain-name (function)
• %get-host-name (function)
• %getifaddrs (function)
• %getpeername (function)
• %getsockname (function)
• %getsockopt (function)
• %if-nametoindex (function)
• %ioctl (function)
• %listen (function)
• %poll (function)
• %read (function)
• %recv (function)
• %recvfrom (function)
• %res-ndestroy (function)
• %res-ninit (function)
• %send (function)
• %sendto (function)
• %setsockopt (function)
• %shutdown-socket (function)
• %socket (function)
• %var-accessor-*errno* (function)
• (setf %var-accessor-*errno*) (function)
• %write (function)
• *errno* (symbol macro)
• +af-inet+ (constant)
• +af-inet6+ (constant)
• +af-unix+ (constant)
• +arphrd-80211+ (constant)
• +arphrd-ether+ (constant)
• +arphrd-loopback+ (constant)
• +arphrd-ppp+ (constant)
• +can-raw+ (constant)
• +einprogress+ (constant)
• +ewouldblock+ (constant)
• +f-getfl+ (constant)
• +f-setfl+ (constant)
• +fionbio+ (constant)
• +iff-loopback+ (constant)
• +iff-up+ (constant)
• +ip-multicast-if+ (constant)
• +ip-multicast-loop+ (constant)
• +ip-multicast-ttl+ (constant)
• +ip6-multicast-if+ (constant)
• +ip6-multicast-loop+ (constant)
• +ipproto-ip+ (constant)
• +ipproto-ip6+ (constant)
• +ipproto-tcp+ (constant)
• +ipproto-udp+ (constant)
• +ipv6-multicast-hops+ (constant)
• +mcast-join-group+ (constant)
• +o-nonblock+ (constant)
• +pf-can+ (constant)
• +siocgifbrdaddr+ (constant)
• +siocgifhwaddr+ (constant)
• +siocgifindex+ (constant)
• +siocgifmtu+ (constant)
• +siocgifname+ (constant)
• +siocgifnetmask+ (constant)
• +siocgstamp+ (constant)
• +so-acceptconn+ (constant)
• +so-broadcast+ (constant)
• +so-error+ (constant)
• +so-rcvbuf+ (constant)
• +so-rcvtimeo+ (constant)
• +so-reuseaddr+ (constant)
• +so-sndbuf+ (constant)
• +so-sndtimeo+ (constant)
• +sock-dgram+ (constant)
• +sock-raw+ (constant)
• +sock-stream+ (constant)
• +sockaddr-storage+ (constant)
• +socket-error+ (constant)
• +sol-socket+ (constant)
• +syscall-error+ (constant)
• +tcp-nodelay+ (constant)
• adapter-p (function)
• can-frame-tclass (class)
• can-interface (structure)
• can-interface-name (function)
• (setf can-interface-name) (function)
• can-interface-p (function)
• can-packet (structure)
• can-packet-data (function)
• (setf can-packet-data) (function)
• can-packet-id (function)
• (setf can-packet-id) (function)
• can-packet-origin (function)
• (setf can-packet-origin) (function)
• can-packet-p (function)
• can-packet-timestamp (function)
• (setf can-packet-timestamp) (function)
• copy-adapter (function)
• copy-can-interface (function)
• copy-can-packet (function)
• copy-poll-context (function)
• copy-sockaddr-in (function)
• copy-sockaddr-in6 (function)
• dotted-quad-p (function)
• dotted-quad-to-inaddr (function)
• fsocket-error-msg (generic function)
• fsocket-error-msg (method)
• get-last-error (function)
• get-socket-option-boolean (function)
• get-socket-option-int32 (function)
• get-socket-option-uint32 (function)
• group-req-tclass (class)
• htonl (function)
• htons (function)
• ifaddrs-tclass (class)
• ifmap-tclass (class)
• ifreq-tclass (class)
• inaddr-to-dotted-quad (function)
• invalid-socket-p (function)
• make-adapter (function)
• make-poll-context (function)
• ntohs (function)
• poll-context-p (function)
• pollfd-tclass (class)
• posix-error (condition)
• posix-error-code (generic function)
• posix-error-code (method)
• res-state-tclass (class)
• set-nonblocking (function)
• set-socket-option-boolean (function)
• set-socket-option-int32 (function)
• set-socket-option-pointer (function)
• set-socket-option-uint32 (function)
• sockaddr-can-tclass (class)
• sockaddr-in-tclass (class)
• sockaddr-in6-flowinfo (function)
• (setf sockaddr-in6-flowinfo) (function)
• sockaddr-in6-scopeid (function)
• (setf sockaddr-in6-scopeid) (function)
• sockaddr-in6-tclass (class)
• sockaddr-un-tclass (class)
• socket-flags (function)
• (setf socket-flags) (function)
• strerror (function)
• tcp-stream-fd (generic function)
• tcp-stream-fd (method)
• timeval-tclass (class)
• tp-tclass (class)
• translate-sockaddr-family (function)
• translate-sockaddr-from-foreign (function)
• with-syscall-else-error (macro)
• with-tcp-stream (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: doevents (POLLFD EVENT) POLL-FORM &body BODY

Evaluate the POLL-FORM and iterate over each of the pollfds with events pending.
On each iteration, POLLFD will be bound to the associated pollfd strcuture and EVENTS will be bound to a list of symbols naming each pending event.

Package

fsocket

Source

common.lisp (file)

Macro: with-can-socket (SOCKET &optional INTERFACE-NAME) &rest BODY

Package

fsocket

Source

posix.lisp (file)

Macro: with-poll (VAR) &body BODY

Evaludate BODY with VAR bound to a poll context.

Package

fsocket

Source

common.lisp (file)

Macro: with-socket (VAR &optional TYPE FAMILY) &body BODY

Execute the body ensuring the socket bound to VAR is closed.

Package

fsocket

Source

common.lisp (file)

Macro: with-tcp-connection (VAR ADDR) &body BODY

Evaluate BODY with VAR bound to a connected TCP socket. VAR ::= variable
ADDR ::= address to connect to.

Package

fsocket

Source

common.lisp (file)

Macro: with-tcp-socket (VAR &optional PORT) &body BODY

Evaluate BODY with VAR bound to a listening TCP socket.
VAR ::= variable that holds the listening TCP socket.
PORT ::= port to bind socket to, defaults to the wildcard port 0.

Package

fsocket

Source

common.lisp (file)

Macro: with-udp-socket (VAR &optional PORT) &body BODY

Evaludate BODY with VAR bound to a UDP socket.
VAR ::= variable that holds the socket.
PORT ::= the port to bind VAR to, defaults to the wildcard port 0.

Package

fsocket

Source

common.lisp (file)

5.1.2 Functions

Function: adapter-address INSTANCE

Function: (setf adapter-address) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-broadcast INSTANCE

Function: (setf adapter-broadcast) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-index INSTANCE

Function: (setf adapter-index) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-mtu INSTANCE

Function: (setf adapter-mtu) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-name INSTANCE

Function: (setf adapter-name) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-netmask INSTANCE

Function: (setf adapter-netmask) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-status INSTANCE

Function: (setf adapter-status) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-type INSTANCE

Function: (setf adapter-type) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: adapter-unicast INSTANCE

Function: (setf adapter-unicast) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: close-poll PC

Close a poll context

Package

fsocket

Source

posix.lisp (file)

Function: close-socket FD

Close the socket named by FD.

Package

fsocket

Source

posix.lisp (file)

Function: get-host-name ()

Package

fsocket

Source

posix.lisp (file)

Function: get-name-servers ()

Returns a list of SOCKADDR-IN addresses for configured DNS name servers.

Package

fsocket

Source

posix.lisp (file)

Function: list-adapters ()

Package

fsocket

Source

posix.lisp (file)

Function: loopback-p ADDR

Returns true if the address references IPv4 127.0.0.1 or IPv6 ::1, false otherwise. ADDR ::= a SOCKADDR-IN or SOCKADDR-IN6 address structure.

Package

fsocket

Source

common.lisp (file)

Function: make-can-interface &key (NAME NAME)

Package

fsocket

Source

common.lisp (file)

Function: make-can-packet &key (ID ID) (DATA DATA) (TIMESTAMP TIMESTAMP) (ORIGIN ORIGIN)

Package

fsocket

Source

common.lisp (file)

Function: make-sockaddr-in &key (ADDR ADDR) (PORT PORT)

Package

fsocket

Source

common.lisp (file)

Function: make-sockaddr-in6 &key (ADDR ADDR) (PORT PORT) (FLOWINFO FLOWINFO) (SCOPEID SCOPEID)

Package

fsocket

Source

common.lisp (file)

Function: make-tcp-stream FD

Wrap a TCP connection with a gray-stream.
FD ::= TCP connection file descriptor.

Remarks: non-blocking file descriptors are not supported. This is because the read-byte or read-sequence functions may signal an EWOULDBLOCK status if they are not ready for a recv operation. However, if you can ensure a recv would not block before calling read-byte or read-sequence functions then non-blocking sockets should work.

READ-BYTE and SEND-BYTE are extremely inefficient because they call directly to recv() and send(). You should always buffer sends and call write-sequence whereever possible. There is almost never a reason to call read-byte, always call read-sequence into a buffer and wrap that in a stream.

Package

fsocket

Source

streams.lisp (file)

Function: multicast-join SOCK MCADDR &optional ADAPTERS

Join the IPv4 multicast group on all ETHERNET interfaces.

Package

fsocket

Source

options.lisp (file)

Function: open-multicast-socket ADAPTER &key TTL LOOPBACK

Open a socket to be used to send IPv4 multicast datagrams.
ADAPTER ::= adapter to use as originating interface.
TTL ::= integer specifying multicast ttl.
LOOPBACK ::= if true, will receive datagrams sent from loopback device, if false disables loopback.

Returns the unbound socket.

Package

fsocket

Source

options.lisp (file)

Function: open-poll ()

Open a poll context.

Package

fsocket

Source

posix.lisp (file)

Function: open-socket &key FAMILY TYPE PROTOCOL

Open a socket. Call CLOSE-SOCKET to free resources.
FAMILY ::= address family integer. Either :INET, :INET6, :UNIX or :CAN.
TYPE ::= socket type name, defaults to SOCK_DGRAM. Can be :datagram, :stream or :raw. PROTOCOL ::= socket protocol integer. Usually doesn’t need to be specified.

Returns the socket file descriptor.

Package

fsocket

Source

posix.lisp (file)

Function: open-tcp-connection ADDR

Open a TCP connection to ADDR.

Package

fsocket

Source

options.lisp (file)

Function: open-tcp-socket &optional PORT

Open a listening TCP socket bound to local port PORT, defaults to wildcard port.

Package

fsocket

Source

options.lisp (file)

Function: open-udp-socket &optional PORT

Open a UDP socket bound to local port PORT, defaults to wildcard port.

Package

fsocket

Source

options.lisp (file)

Function: parse-can-packet PACKET

Package

fsocket

Source

common.lisp (file)

Function: poll PC &key TIMEOUT

Poll the sockets registered with the poll context for network events.

PC ::= poll context as returne from OPEN-POLL.
TIMEOUT ::= if supplied time in milliseconds to wait. If not supplied defaults to infinity.

Returns a list of registered pollfd structures. Users should check the REVENTS slot for pending events.

Package

fsocket

Source

posix.lisp (file)

Function: poll-context-fds INSTANCE

Function: (setf poll-context-fds) VALUE INSTANCE

Package

fsocket

Source

posix.lisp (file)

Function: poll-event INT-OR-SYM

Map an event name to an event flag or vice versa.

Package

fsocket

Source

common.lisp (file)

Function: poll-event-p EVENT &optional NAME

Event predicate.
EVENT ::= event integer.
NAME ::= event name to test. If not supplied, indicates whether any event is pending.

Package

fsocket

Source

common.lisp (file)

Function: poll-events &rest EVENTS

Map an event integer to a list of event names, or a list of event names to an event integer.

Package

fsocket

Source

common.lisp (file)

Function: poll-find PC FD

Lookup the pollfd for the file descriptor.
PC ::= poll context.
FD ::= file desctipror.
Returns the pollfd with the matching file descriptor if found.

Package

fsocket

Source

posix.lisp (file)

Function: poll-register PC POLLFD

Register a pollfd descriptor with a poll context.

Package

fsocket

Source

posix.lisp (file)

Function: poll-unregister PC POLLFD

Unregister a pollfd descriptor from a poll context.

Package

fsocket

Source

posix.lisp (file)

Function: sockaddr-in &optional INADDR PORT

Allocate a SOCKADDR-IN address structure.
INADDR ::= a vector of 4 octets specifying the internet address. May be entered in the "dotted quad" string format.
If not supplied the wildcard address is used.
PORT ::= integer specifying the port number. If not supplied port 0 will be used.

Returns a new SOCKADDR-IN structure.

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in-addr INSTANCE

Function: (setf sockaddr-in-addr) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in-p OBJECT

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in-port INSTANCE

Function: (setf sockaddr-in-port) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in6 &optional ADDR PORT SCOPEID

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in6-addr INSTANCE

Function: (setf sockaddr-in6-addr) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in6-p OBJECT

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in6-port INSTANCE

Function: (setf sockaddr-in6-port) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-string ADDR

Generate a string of format a.b.c.d:port from the address.

Package

fsocket

Source

common.lisp (file)

Function: sockaddr= SA1 SA2

Package

fsocket

Source

common.lisp (file)

Function: socket-accept FD

Accept a connection from the listening socket.
SOCK ::= listening socket.

Returns (values conn addr) where
CONN ::= new connected socket.
ADDR ::= address of the connected socket.

If the socket is in non-blocking mode and the operation would block returns nil. A :POLLIN event indicates a subsequent socket-accept will complete immediately.

Package

fsocket

Source

posix.lisp (file)

Function: socket-bind FD ADDR

Bind the socket to the local address/interface.
FD ::= socket file descriptor.
ADDR ::= local address or can interface. Can be SOCKADDR-IN, SOCKADDR-IN6 or string for internet sockets; must be of type CAN-INTERFACE for can sockets

Package

fsocket

Source

posix.lisp (file)

Function: socket-connect FD ADDR

Connect the socket to the remote address.
SOCK :: socket.
ADDR ::= remote address.

Returns true if the operation completed successfully.
If the socket is in non-blocking mode and the operation would block returns NIL. A :POLLOUT event indicates a subsequent socket-connect will complete immediately.

Package

fsocket

Source

posix.lisp (file)

Function: socket-listen FD &optional BACKLOG

Start the socket listening.

Package

fsocket

Source

posix.lisp (file)

Function: socket-name FD

Get the address to which the socket has been bound. FD ::= socket as returned from OPEN-SOCKET. Returns a SOCKADDR-IN or SOCKADDR-IN6 structure.

Package

fsocket

Source

posix.lisp (file)

Function: socket-peer FD

Package

fsocket

Source

posix.lisp (file)

Function: socket-recv FD BUFFER &key START END

Receive data from the socket.
FD ::= socket.
BUFFER ::= octet vector, foreign pointer or can-frame that receives data.
START ::= buffer start index.
END ::= buffer end index.

Retuns the number of bytes actually received, which can be less than the number requested.

Package

fsocket

Source

posix.lisp (file)

Function: socket-recvfrom FD BUFFER &key START END

Receive data from the socket.
FD ::= socket.
BUFFER ::= octet vector or foreign pointer.
START ::= start index.
END ::= end index.

Returns (values count addr) where
COUNT ::= number of octets actually received, which can be less tha nthe number requested. ADDR ::= remote address or can-interface from which the data was received.

Package

fsocket

Source

posix.lisp (file)

Function: socket-send FD BUFFER &key START END

Send a buffer on the connected socket.
SOCK ::= connected socket.
BUFFER ::= octet vector, foreign pointer or can-frame.
START ::= start index of buffer.
END ::= end index of buffer.

Returns the number of bytes actually sent, which can be less than the requested length.

Package

fsocket

Source

posix.lisp (file)

Function: socket-sendto FD BUFFER ADDR &key START END

Send data to the address on the socket.
FD ::= socket.
ADDR ::= local address or can interface. Can be SOCKADDR-IN, SOCKADDR-IN6 or string for internet sockets must be of type CAN-INTERFACE for can sockets. ADDR ::= destination address, either a SOCKADDR-IN or SOCKADDR-IN6 structure or a can-interface.
START ::= buffer start index.
END ::= buffer end index.

Returns the number of octets actually sent, which can be less than the number requested.

Package

fsocket

Source

posix.lisp (file)

Function: socket-shutdown FD &optional HOW

Shutdown traffic on the TCP socket.
HOW ::= :SEND to stop sending, :RECEIVE to stop receiving, :BOTH to stop both.

Package

fsocket

Source

posix.lisp (file)

Function: string-sockaddr STRING

Parses a string in the format a.b.c.d[:port] i.e. a dotted quad with optional port. If the port is not specified it defaults to 0.

Package

fsocket

Source

common.lisp (file)

5.1.3 Generic functions

Generic Function: pollfd-events OBJECT

Generic Function: (setf pollfd-events) NEW-VALUE OBJECT

Package

fsocket

Methods

Method: pollfd-events (POLLFD pollfd)

automatically generated reader method

Source

common.lisp (file)

Method: (setf pollfd-events) NEW-VALUE (POLLFD pollfd)

automatically generated writer method

Source

common.lisp (file)

Generic Function: pollfd-fd OBJECT

Generic Function: (setf pollfd-fd) NEW-VALUE OBJECT

Package

fsocket

Methods

Method: pollfd-fd (POLLFD pollfd)

automatically generated reader method

Source

common.lisp (file)

Method: (setf pollfd-fd) NEW-VALUE (POLLFD pollfd)

automatically generated writer method

Source

common.lisp (file)

Generic Function: pollfd-revents OBJECT

Generic Function: (setf pollfd-revents) NEW-VALUE OBJECT

Package

fsocket

Methods

Method: pollfd-revents (POLLFD pollfd)

automatically generated reader method

Source

common.lisp (file)

Method: (setf pollfd-revents) NEW-VALUE (POLLFD pollfd)

automatically generated writer method

Source

common.lisp (file)

Generic Function: socket-option SOCK LEVEL OPTION

Get a socket option.
SOCK ::= socket.
LEVEL ::= symbol naming a level. OPTION ::= symbol naming a socket option.

Returns the value of the named option.

Package

fsocket

Source

options.lisp (file)

Writer

(setf socket-option) (generic function)

Methods

Method: socket-option SOCK (LEVEL (eql tcp)) (OPTION (eql nodelay))

Method: socket-option SOCK (LEVEL (eql ip)) (OPTION (eql ip-multicast-if))

Method: socket-option SOCK (LEVEL (eql socket)) (OPTION (eql rcvtimeo))

Method: socket-option SOCK (LEVEL (eql socket)) (OPTION (eql error))

Method: socket-option SOCK (LEVEL (eql socket)) (OPTION (eql rcvbuf))

Method: socket-option SOCK (LEVEL (eql socket)) (OPTION (eql sndbuf))

Method: socket-option SOCK (LEVEL (eql socket)) (OPTION (eql reuseaddr))

Method: socket-option SOCK (LEVEL (eql socket)) (OPTION (eql broadcast))

Method: socket-option SOCK (LEVEL (eql socket)) (OPTION (eql acceptconn))

Generic Function: (setf socket-option) VALUE SOCK LEVEL OPTION

Set a socket option.
SOCK ::= socket
LEVEL ::= symbol naming a socket level. OPTION ::= symbol naming a socket option. VALUE ::= value to set.

Package

fsocket

Source

options.lisp (file)

Reader

socket-option (generic function)

Methods

Method: (setf socket-option) VALUE SOCK (LEVEL (eql tcp)) (OPTION (eql nodelay))

Method: (setf socket-option) VALUE SOCK (LEVEL (eql ip)) (OPTION (eql ip-multicast-if))

Set the local interface to use. VALUE is a 4-octet array indicating the local address.

Method: (setf socket-option) VALUE SOCK (LEVEL (eql socket)) (OPTION (eql rcvtimeo))

Method: (setf socket-option) VALUE SOCK (LEVEL (eql socket)) (OPTION (eql rcvbuf))

Method: (setf socket-option) VALUE SOCK (LEVEL (eql socket)) (OPTION (eql sndbuf))

Method: (setf socket-option) VALUE SOCK (LEVEL (eql socket)) (OPTION (eql reuseaddr))

Method: (setf socket-option) VALUE SOCK (LEVEL (eql socket)) (OPTION (eql broadcast))

Method: (setf socket-option) VALUE SOCK (LEVEL (eql socket)) (OPTION (eql acceptconn))

Method: (setf socket-option) VALUE SOCK (LEVEL (eql ip)) (OPTION (eql ip-multicast-loop))

Set to use or not use loopback. Value is a boolean

Method: (setf socket-option) VALUE SOCK (LEVEL (eql ip)) (OPTION (eql ip-multicast-ttl))

Set the mutlicast TTL. Value is an integer.

Method: (setf socket-option) VALUE SOCK (LEVEL (eql ip)) (OPTION (eql mcast-join-group))

VALUE ::= (index address) where INDEX is the interface index and ADDRESS is the multicast address to join.

Method: (setf socket-option) VALUE SOCK (LEVEL (eql socket)) (OPTION (eql sndtimeo))

5.1.4 Conditions

Condition: fsocket-error ()

Package

fsocket

Source

errors.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

posix-error (condition)

Direct methods

fsocket-error-msg (method)

Direct slots

Slot: msg

Initargs

:msg

Initform

(quote nil)

Readers

fsocket-error-msg (generic function)

Condition: fsocket-short-buffer ()

Package

fsocket

Source

errors.lisp (file)

Direct superclasses

condition (condition)

5.1.5 Structures

Structure: adapter ()

Package

fsocket

Source

common.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

adapter-name (function)

Writers

(setf adapter-name) (function)

Slot: type

Readers

adapter-type (function)

Writers

(setf adapter-type) (function)

Slot: address

Readers

adapter-address (function)

Writers

(setf adapter-address) (function)

Slot: index

Readers

adapter-index (function)

Writers

(setf adapter-index) (function)

Slot: unicast

Readers

adapter-unicast (function)

Writers

(setf adapter-unicast) (function)

Slot: netmask

Readers

adapter-netmask (function)

Writers

(setf adapter-netmask) (function)

Slot: broadcast

Readers

adapter-broadcast (function)

Writers

(setf adapter-broadcast) (function)

Slot: status

Readers

adapter-status (function)

Writers

(setf adapter-status) (function)

Slot: mtu

Readers

adapter-mtu (function)

Writers

(setf adapter-mtu) (function)

Structure: poll-context ()

Package

fsocket

Source

posix.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: fds

Readers

poll-context-fds (function)

Writers

(setf poll-context-fds) (function)

Structure: sockaddr-in ()

Package

fsocket

Source

common.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

translate-into-foreign-memory (method)

Direct slots

Slot: addr

Initform

(make-array 4 :initial-element 0)

Readers

sockaddr-in-addr (function)

Writers

(setf sockaddr-in-addr) (function)

Slot: port

Initform

0

Readers

sockaddr-in-port (function)

Writers

(setf sockaddr-in-port) (function)

Structure: sockaddr-in6 ()

Package

fsocket

Source

common.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

translate-into-foreign-memory (method)

Direct slots

Slot: addr

Initform

(make-array 8 :initial-element 0)

Readers

sockaddr-in6-addr (function)

Writers

(setf sockaddr-in6-addr) (function)

Slot: port

Initform

0

Readers

sockaddr-in6-port (function)

Writers

(setf sockaddr-in6-port) (function)

Slot: flowinfo

Initform

0

Readers

sockaddr-in6-flowinfo (function)

Writers

(setf sockaddr-in6-flowinfo) (function)

Slot: scopeid

Initform

0

Readers

sockaddr-in6-scopeid (function)

Writers

(setf sockaddr-in6-scopeid) (function)

5.1.6 Classes

Class: pollfd ()

Package

fsocket

Source

common.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• pollfd-revents (method)
• pollfd-revents (method)
• pollfd-events (method)
• pollfd-events (method)
• pollfd-fd (method)
• pollfd-fd (method)

Direct slots

Slot: fd

Initargs

:fd

Initform

-1

Readers

pollfd-fd (generic function)

Writers

(setf pollfd-fd) (generic function)

Slot: events

Initargs

:events

Initform

0

Readers

pollfd-events (generic function)

Writers

(setf pollfd-events) (generic function)

Slot: revents

Initargs

:revents

Initform

0

Readers

pollfd-revents (generic function)

Writers

(setf pollfd-revents) (generic function)

Class: tcp-stream ()

Package

fsocket

Source

streams.lisp (file)

Direct superclasses

• fundamental-binary-output-stream (class)
• fundamental-binary-input-stream (class)
• trivial-gray-stream-mixin (class)

Direct methods

• close (method)
• stream-finish-output (method)
• stream-force-output (method)
• stream-write-sequence (method)
• stream-read-sequence (method)
• stream-write-byte (method)
• stream-read-byte (method)
• stream-element-type (method)
• tcp-stream-fd (method)

Direct slots

Slot: fd

TCP connection file descriptor/handle.

Initargs

:fd

Readers

tcp-stream-fd (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +af-inet+

Package

fsocket

Source

constants.lisp (file)

Constant: +af-inet6+

Package

fsocket

Source

constants.lisp (file)

Constant: +af-unix+

Package

fsocket

Source

constants.lisp (file)

Constant: +arphrd-80211+

Package

fsocket

Source

posix.lisp (file)

Constant: +arphrd-ether+

Package

fsocket

Source

posix.lisp (file)

Constant: +arphrd-loopback+

Package

fsocket

Source

posix.lisp (file)

Constant: +arphrd-ppp+

Package

fsocket

Source

posix.lisp (file)

Constant: +can-raw+

Package

fsocket

Source

constants.lisp (file)

Constant: +einprogress+

Package

fsocket

Source

posix.lisp (file)

Constant: +ewouldblock+

Package

fsocket

Source

posix.lisp (file)

Constant: +f-getfl+

Package

fsocket

Source

posix.lisp (file)

Constant: +f-setfl+

Package

fsocket

Source

posix.lisp (file)

Constant: +fionbio+

Package

fsocket

Source

posix.lisp (file)

Constant: +iff-loopback+

Package

fsocket

Source

posix.lisp (file)

Constant: +iff-up+

Package

fsocket

Source

posix.lisp (file)

Constant: +ip-multicast-if+

Package

fsocket

Source

constants.lisp (file)

Constant: +ip-multicast-loop+

Package

fsocket

Source

constants.lisp (file)

Constant: +ip-multicast-ttl+

Package

fsocket

Source

constants.lisp (file)

Constant: +ip6-multicast-if+

Package

fsocket

Source

constants.lisp (file)

Constant: +ip6-multicast-loop+

Package

fsocket

Source

constants.lisp (file)

Constant: +ipproto-ip+

Package

fsocket

Source

constants.lisp (file)

Constant: +ipproto-ip6+

Package

fsocket

Source

constants.lisp (file)

Constant: +ipproto-tcp+

Package

fsocket

Source

constants.lisp (file)

Constant: +ipproto-udp+

Package

fsocket

Source

constants.lisp (file)

Constant: +ipv6-multicast-hops+

Package

fsocket

Source

constants.lisp (file)

Constant: +mcast-join-group+

Package

fsocket

Source

constants.lisp (file)

Constant: +o-nonblock+

Package

fsocket

Source

posix.lisp (file)

Constant: +pf-can+

Package

fsocket

Source

constants.lisp (file)

Constant: +siocgifbrdaddr+

Package

fsocket

Source

posix.lisp (file)

Constant: +siocgifhwaddr+

Package

fsocket

Source

posix.lisp (file)

Constant: +siocgifindex+

Package

fsocket

Source

constants.lisp (file)

Constant: +siocgifmtu+

Package

fsocket

Source

posix.lisp (file)

Constant: +siocgifname+

Package

fsocket

Source

constants.lisp (file)

Constant: +siocgifnetmask+

Package

fsocket

Source

posix.lisp (file)

Constant: +siocgstamp+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-acceptconn+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-broadcast+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-error+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-rcvbuf+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-rcvtimeo+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-reuseaddr+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-sndbuf+

Package

fsocket

Source

constants.lisp (file)

Constant: +so-sndtimeo+

Package

fsocket

Source

constants.lisp (file)

Constant: +sock-dgram+

Package

fsocket

Source

constants.lisp (file)

Constant: +sock-raw+

Package

fsocket

Source

constants.lisp (file)

Constant: +sock-stream+

Package

fsocket

Source

constants.lisp (file)

Constant: +sockaddr-storage+

Package

fsocket

Source

posix.lisp (file)

Constant: +socket-error+

Package

fsocket

Source

posix.lisp (file)

Constant: +sol-socket+

Package

fsocket

Source

constants.lisp (file)

Constant: +syscall-error+

Package

fsocket

Source

posix.lisp (file)

Constant: +tcp-nodelay+

Package

fsocket

Source

constants.lisp (file)

5.2.2 Symbol macros

Symbol Macro: *errno*

Package

fsocket

Source

posix.lisp (file)

Expansion

(fsocket::%var-accessor-*errno*)

5.2.3 Macros

Macro: with-syscall-else-error SYSCALL ERROR

Package

fsocket

Source

posix.lisp (file)

Macro: with-tcp-stream (VAR FD) &body BODY

Evaluate BODY in a context where VAR is bound to the TCP file descriptor.

Package

fsocket

Source

streams.lisp (file)

5.2.4 Functions

Function: %accept FD ADDR LEN

Package

fsocket

Source

posix.lisp (file)

Function: %bind FD ADDR LEN

Package

fsocket

Source

posix.lisp (file)

Function: %close FD

Package

fsocket

Source

posix.lisp (file)

Function: %connect FD ADDR LEN

Package

fsocket

Source

posix.lisp (file)

Function: %fcntl FD CMD ARG

Package

fsocket

Source

posix.lisp (file)

Function: %freeifaddrs IFADDRS

Package

fsocket

Source

posix.lisp (file)

Function: %get-domain-name NAME LEN

Package

fsocket

Source

posix.lisp (file)

Function: %get-host-name NAME LEN

Package

fsocket

Source

posix.lisp (file)

Function: %getifaddrs IFADDRS

Package

fsocket

Source

posix.lisp (file)

Function: %getpeername FD ADDR LEN

Package

fsocket

Source

posix.lisp (file)

Function: %getsockname FD ADDR LEN

Package

fsocket

Source

posix.lisp (file)

Function: %getsockopt FD LEVEL OPTION VAL VLEN

Package

fsocket

Source

posix.lisp (file)

Function: %if-nametoindex NAME

Package

fsocket

Source

posix.lisp (file)

Function: %ioctl FD REQ ARGP

Package

fsocket

Source

posix.lisp (file)

Function: %listen FD BACKLOG

Package

fsocket

Source

posix.lisp (file)

Function: %poll FDS COUNT TIMEOUT

Package

fsocket

Source

posix.lisp (file)

Function: %read FD BUFFER COUNT

Package

fsocket

Source

common.lisp (file)

Function: %recv FD BUFFER LEN FLAGS

Package

fsocket

Source

posix.lisp (file)

Function: %recvfrom FD BUFFER LEN FLAGS ADDR ALEN

Package

fsocket

Source

posix.lisp (file)

Function: %res-ndestroy STATE

Package

fsocket

Source

posix.lisp (file)

Function: %res-ninit STATE

Package

fsocket

Source

posix.lisp (file)

Function: %send FD BUFFER LEN FLAGS

Package

fsocket

Source

posix.lisp (file)

Function: %sendto FD BUFFER LEN FLAGS ADDR ALEN

Package

fsocket

Source

posix.lisp (file)

Function: %setsockopt FD LEVEL OPTION VAL VLEN

Package

fsocket

Source

posix.lisp (file)

Function: %shutdown-socket FD HOW

Package

fsocket

Source

posix.lisp (file)

Function: %socket FAMILY TYPE PROT

Package

fsocket

Source

posix.lisp (file)

Function: %var-accessor-*errno* ()

Function: (setf %var-accessor-*errno*) VALUE

Package

fsocket

Source

posix.lisp (file)

Function: %write FD BUFFER COUNT

Package

fsocket

Source

common.lisp (file)

Function: adapter-p OBJECT

Package

fsocket

Source

common.lisp (file)

Function: can-interface-name INSTANCE

Function: (setf can-interface-name) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: can-interface-p OBJECT

Package

fsocket

Source

common.lisp (file)

Function: can-packet-data INSTANCE

Function: (setf can-packet-data) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: can-packet-id INSTANCE

Function: (setf can-packet-id) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: can-packet-origin INSTANCE

Function: (setf can-packet-origin) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: can-packet-p OBJECT

Package

fsocket

Source

common.lisp (file)

Function: can-packet-timestamp INSTANCE

Function: (setf can-packet-timestamp) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: copy-adapter INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: copy-can-interface INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: copy-can-packet INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: copy-poll-context INSTANCE

Package

fsocket

Source

posix.lisp (file)

Function: copy-sockaddr-in INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: copy-sockaddr-in6 INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: dotted-quad-p STRING

Package

fsocket

Source

common.lisp (file)

Function: dotted-quad-to-inaddr STRING &optional ERROR-P

Package

fsocket

Source

common.lisp (file)

Function: get-last-error &optional ECODE

Package

fsocket

Source

posix.lisp (file)

Function: get-socket-option-boolean SOCK LEVEL OPTION

Package

fsocket

Source

options.lisp (file)

Function: get-socket-option-int32 SOCK LEVEL OPTION

Package

fsocket

Source

options.lisp (file)

Function: get-socket-option-uint32 SOCK LEVEL OPTION

Package

fsocket

Source

options.lisp (file)

Function: htonl INTEGER

Return a 32-bit big-endian integer

Package

fsocket

Source

common.lisp (file)

Function: htons INTEGER

Return a 16-bit big-endian integer

Package

fsocket

Source

common.lisp (file)

Function: inaddr-to-dotted-quad INADDR

Package

fsocket

Source

common.lisp (file)

Function: invalid-socket-p SOCK

Package

fsocket

Source

posix.lisp (file)

Function: make-adapter &key (NAME NAME) (TYPE TYPE) (ADDRESS ADDRESS) (INDEX INDEX) (UNICAST UNICAST) (NETMASK NETMASK) (BROADCAST BROADCAST) (STATUS STATUS) (MTU MTU)

Package

fsocket

Source

common.lisp (file)

Function: make-poll-context &key (FDS FDS)

Package

fsocket

Source

posix.lisp (file)

Function: ntohs INTEGER

Return a 16-bit integer converted from big-endian

Package

fsocket

Source

common.lisp (file)

Function: poll-context-p OBJECT

Package

fsocket

Source

posix.lisp (file)

Function: set-nonblocking FD

Package

fsocket

Source

posix.lisp (file)

Function: set-socket-option-boolean SOCK LEVEL OPTION VALUE

Package

fsocket

Source

options.lisp (file)

Function: set-socket-option-int32 SOCK LEVEL OPTION VALUE

Package

fsocket

Source

options.lisp (file)

Function: set-socket-option-pointer SOCK LEVEL OPTION POINTER LEN

Package

fsocket

Source

options.lisp (file)

Function: set-socket-option-uint32 SOCK LEVEL OPTION VALUE

Package

fsocket

Source

options.lisp (file)

Function: sockaddr-in6-flowinfo INSTANCE

Function: (setf sockaddr-in6-flowinfo) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: sockaddr-in6-scopeid INSTANCE

Function: (setf sockaddr-in6-scopeid) VALUE INSTANCE

Package

fsocket

Source

common.lisp (file)

Function: socket-flags FD

Function: (setf socket-flags) FLAGS FD

Package

fsocket

Source

posix.lisp (file)

Function: strerror STS

Package

fsocket

Source

posix.lisp (file)

Function: translate-sockaddr-family PTR

Package

fsocket

Source

common.lisp (file)

Function: translate-sockaddr-from-foreign PTR

Package

fsocket

Source

common.lisp (file)

5.2.5 Generic functions

Generic Function: fsocket-error-msg CONDITION

Package

fsocket

Methods

Method: fsocket-error-msg (CONDITION fsocket-error)

Source

errors.lisp (file)

Generic Function: posix-error-code CONDITION

Package

fsocket

Methods

Method: posix-error-code (CONDITION posix-error)

Source

posix.lisp (file)

Generic Function: tcp-stream-fd OBJECT

Package

fsocket

Methods

Method: tcp-stream-fd (TCP-STREAM tcp-stream)

TCP connection file descriptor/handle.

Source

streams.lisp (file)

5.2.6 Conditions

Condition: posix-error ()

Package

fsocket

Source

posix.lisp (file)

Direct superclasses

fsocket-error (condition)

Direct methods

posix-error-code (method)

Direct slots

Slot: code

Initargs

:code

Initform

(quote 0)

Readers

posix-error-code (generic function)

5.2.7 Structures

Structure: can-interface ()

Package

fsocket

Source

common.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Initform

"any"

Readers

can-interface-name (function)

Writers

(setf can-interface-name) (function)

Structure: can-packet ()

Package

fsocket

Source

common.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: id

Readers

can-packet-id (function)

Writers

(setf can-packet-id) (function)

Slot: data

Readers

can-packet-data (function)

Writers

(setf can-packet-data) (function)

Slot: timestamp

Readers

can-packet-timestamp (function)

Writers

(setf can-packet-timestamp) (function)

Slot: origin

Readers

can-packet-origin (function)

Writers

(setf can-packet-origin) (function)