Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the ip-interfaces Reference Manual, version 0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:30:18 2021 GMT+0.
| • Introduction | What ip-interfaces is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
The ip-interfaces library provides a convenient way to obtain a list of available interfaces on a machine.
IP-Interfaces is a port of Clozure CL's %get-ip-interfaces function to CFFI so that it can run on other lisp implementations. So far ip-interfaces has been tested successfully on the following platforms:
| Implementation | Windows | Mac OS X | Linux | OpenBSD | | :------------- | :------ | :------- | :---- | :------ | | SBCL | Yes | Yes | Yes | Yes | | CMUCL | | Yes | Yes | | | CLISP | Yes | Yes | Yes | Yes | | Clozure | Yes | Yes | Yes | | | Allegro | Yes | Yes | Yes | | | ECL | | Yes | Yes | Yes | | LispWorks | Yes | | | |
IP-Interfaces is released under the LLGPL to maintain license compatibility with Clozure CL.
Note: ip-interfaces is not a socket library. If you are looking for a portable socket library, check out usocket.
The API for ip-interfaces consists of a single function, get-ip-interfaces, which returns a list of ip-interface structs containing information about the interfaces on the machine:
* (ql:quickload :ip-interfaces)
NIL
* (use-package :ip-interfaces)
T
* (get-ip-interfaces)
(#S(IP-INTERFACES::IP-INTERFACE
:NAME "lo0"
:ADDRESS #(127 0 0 1)
:NETMASK #(255 0 0 0)
:BROADCAST-ADDRESS #(127 0 0 1)
:FLAGS 32841
:ADDRESS-FAMILY :AF-INET)
...)
* (ip-interface-address (first *))
#(127 0 0 1)
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The ip-interfaces system |
Elliott Slaughter <elliottslaughter@gmail.com>
LLGPL
Query network interfaces on the local machine.
0.0
cffi
ip-interfaces.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The ip-interfaces.asd file | ||
| • The ip-interfaces/package.lisp file | ||
| • The ip-interfaces/sockets.lisp file | ||
| • The ip-interfaces/ip-interfaces.lisp file |
Next: The ip-interfaces/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
ip-interfaces.asd
ip-interfaces (system)
Next: The ip-interfaces/sockets․lisp file, Previous: The ip-interfaces․asd file, Up: Lisp files [Contents][Index]
ip-interfaces (system)
package.lisp
Next: The ip-interfaces/ip-interfaces․lisp file, Previous: The ip-interfaces/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
ip-interfaces (system)
sockets.lisp
Previous: The ip-interfaces/sockets․lisp file, Up: Lisp files [Contents][Index]
sockets.lisp (file)
ip-interfaces (system)
ip-interfaces.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The ip-interfaces-asd package | ||
| • The ip-interfaces package |
Next: The ip-interfaces package, Previous: Packages, Up: Packages [Contents][Index]
ip-interfaces.asd
Previous: The ip-interfaces-asd package, Up: Packages [Contents][Index]
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions |
Previous: Exported definitions, Up: Exported definitions [Contents][Index]
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions | ||
| • Internal structures | ||
| • Internal classes |
Next: Internal structures, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
sockets.lisp (file)
sockets.lisp (file)
ip-interfaces.lisp (file)
ip-interfaces.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
ip-interfaces.lisp (file)
structure-object (structure)
ip-interface-name (function)
(setf ip-interface-name) (function)
ip-interface-address (function)
(setf ip-interface-address) (function)
ip-interface-netmask (function)
(setf ip-interface-netmask) (function)
ip-interface-broadcast-address (function)
(setf ip-interface-broadcast-address) (function)
ip-interface-flags (function)
(setf ip-interface-flags) (function)
ip-interface-address-family (function)
(setf ip-interface-address-family) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
sockets.lisp (file)
sockets.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F I L |
|---|
| Jump to: | F I L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
B C F G I M |
|---|
| Jump to: | (
B C F G I M |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | A B F N S |
|---|
| Jump to: | A B F N S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C I P S |
|---|
| Jump to: | C I P S |
|---|