The ip-interfaces Reference Manual

This is the ip-interfaces Reference Manual, version 0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 06:20:06 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 ip-interfaces

Query network interfaces on the local machine.

Author

Elliott Slaughter <>

License

LLGPL

Version

0.0

Dependency

cffi (system).

Source

ip-interfaces.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 ip-interfaces/ip-interfaces.asd

Source

ip-interfaces.asd.

Parent Component

ip-interfaces (system).

ASDF Systems

ip-interfaces.

Packages

ip-interfaces-asd.


3.1.2 ip-interfaces/package.lisp

Source

ip-interfaces.asd.

Parent Component

ip-interfaces (system).

Packages

ip-interfaces.


3.1.3 ip-interfaces/sockets.lisp

Dependency

package.lisp (file).

Source

ip-interfaces.asd.

Parent Component

ip-interfaces (system).

Internals

3.1.4 ip-interfaces/ip-interfaces.lisp

Dependency

sockets.lisp (file).

Source

ip-interfaces.asd.

Parent Component

ip-interfaces (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 ip-interfaces-asd

Source

ip-interfaces.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 ip-interfaces

Source

package.lisp.

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: filter-ip-interfaces-by-flags (ip-interfaces flags-to-include &optional flags-to-exclude)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Function: get-ip-interfaces ()
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Function: get-ip-interfaces-by-flags (flags-to-include &optional flags-to-exclude)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Reader: ip-interface-address (instance)
Writer: (setf ip-interface-address) (instance)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Target Slot

address.

Reader: ip-interface-address-family (instance)
Writer: (setf ip-interface-address-family) (instance)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Target Slot

address-family.

Reader: ip-interface-broadcast-address (instance)
Writer: (setf ip-interface-broadcast-address) (instance)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Target Slot

broadcast-address.

Reader: ip-interface-flags (instance)
Writer: (setf ip-interface-flags) (instance)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Target Slot

flags.

Reader: ip-interface-name (instance)
Writer: (setf ip-interface-name) (instance)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Target Slot

name.

Reader: ip-interface-netmask (instance)
Writer: (setf ip-interface-netmask) (instance)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Target Slot

netmask.


5.2 Internals


5.2.1 Ordinary functions

Function: bytes (pointer count)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Function: copy-ip-interface (instance)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Function: flag-value (flag)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Function: freeifaddrs (ifaddrs)
Package

ip-interfaces.

Source

sockets.lisp.

Function: getifaddrs (ifaddrs)
Package

ip-interfaces.

Source

sockets.lisp.

Function: ip-interface-p (object)
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Function: make-ip-interface (&key name address netmask broadcast-address flags address-family)
Package

ip-interfaces.

Source

ip-interfaces.lisp.


5.2.2 Structures

Structure: ip-interface
Package

ip-interfaces.

Source

ip-interfaces.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Readers

ip-interface-name.

Writers

(setf ip-interface-name).

Slot: address
Readers

ip-interface-address.

Writers

(setf ip-interface-address).

Slot: netmask
Readers

ip-interface-netmask.

Writers

(setf ip-interface-netmask).

Slot: broadcast-address
Readers

ip-interface-broadcast-address.

Writers

(setf ip-interface-broadcast-address).

Slot: flags
Readers

ip-interface-flags.

Writers

(setf ip-interface-flags).

Slot: address-family
Readers

ip-interface-address-family.

Writers

(setf ip-interface-address-family).


5.2.3 Classes

Class: ifaddrs-tclass
Package

ip-interfaces.

Source

sockets.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: sockaddr-tclass
Package

ip-interfaces.

Source

sockets.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   F   G   I   M  
Index Entry  Section

(
(setf ip-interface-address): Public ordinary functions
(setf ip-interface-address-family): Public ordinary functions
(setf ip-interface-broadcast-address): Public ordinary functions
(setf ip-interface-flags): Public ordinary functions
(setf ip-interface-name): Public ordinary functions
(setf ip-interface-netmask): Public ordinary functions

B
bytes: Private ordinary functions

C
copy-ip-interface: Private ordinary functions

F
filter-ip-interfaces-by-flags: Public ordinary functions
flag-value: Private ordinary functions
freeifaddrs: Private ordinary functions
Function, (setf ip-interface-address): Public ordinary functions
Function, (setf ip-interface-address-family): Public ordinary functions
Function, (setf ip-interface-broadcast-address): Public ordinary functions
Function, (setf ip-interface-flags): Public ordinary functions
Function, (setf ip-interface-name): Public ordinary functions
Function, (setf ip-interface-netmask): Public ordinary functions
Function, bytes: Private ordinary functions
Function, copy-ip-interface: Private ordinary functions
Function, filter-ip-interfaces-by-flags: Public ordinary functions
Function, flag-value: Private ordinary functions
Function, freeifaddrs: Private ordinary functions
Function, get-ip-interfaces: Public ordinary functions
Function, get-ip-interfaces-by-flags: Public ordinary functions
Function, getifaddrs: Private ordinary functions
Function, ip-interface-address: Public ordinary functions
Function, ip-interface-address-family: Public ordinary functions
Function, ip-interface-broadcast-address: Public ordinary functions
Function, ip-interface-flags: Public ordinary functions
Function, ip-interface-name: Public ordinary functions
Function, ip-interface-netmask: Public ordinary functions
Function, ip-interface-p: Private ordinary functions
Function, make-ip-interface: Private ordinary functions

G
get-ip-interfaces: Public ordinary functions
get-ip-interfaces-by-flags: Public ordinary functions
getifaddrs: Private ordinary functions

I
ip-interface-address: Public ordinary functions
ip-interface-address-family: Public ordinary functions
ip-interface-broadcast-address: Public ordinary functions
ip-interface-flags: Public ordinary functions
ip-interface-name: Public ordinary functions
ip-interface-netmask: Public ordinary functions
ip-interface-p: Private ordinary functions

M
make-ip-interface: Private ordinary functions