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

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 Mon Feb 26 16:47:04 2024 GMT+0.

Next: Systems, Previous: The ip-interfaces Reference Manual, Up: The ip-interfaces Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The ip-interfaces Reference Manual [Contents][Index]

2 Systems

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

ip-interfaces

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

2.1 `ip-interfaces`

Query network interfaces on the local machine.

Author

Elliott Slaughter <elliottslaughter@gmail.com>

License

LLGPL

Version

0.0

Dependency

cffi (system).

Source

ip-interfaces.asd.

Child Components

package.lisp (file).
sockets.lisp (file).
ip-interfaces.lisp (file).

Next: Packages, Previous: Systems, Up: The ip-interfaces Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: ip-interfaces/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

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.

Next: ip-interfaces/sockets.lisp, Previous: ip-interfaces/ip-interfaces.asd, Up: Lisp [Contents][Index]

3.1.2 `ip-interfaces/package.lisp`

Source: ip-interfaces.asd.
Parent Component: ip-interfaces (system).
Packages: ip-interfaces.

Next: ip-interfaces/ip-interfaces.lisp, Previous: ip-interfaces/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `ip-interfaces/sockets.lisp`

Dependency

package.lisp (file).

Source

ip-interfaces.asd.

Parent Component

ip-interfaces (system).

Internals

freeifaddrs (function).
getifaddrs (function).
ifaddrs-tclass (class).
sockaddr-tclass (class).

Previous: ip-interfaces/sockets.lisp, Up: Lisp [Contents][Index]

3.1.4 `ip-interfaces/ip-interfaces.lisp`

Dependency

sockets.lisp (file).

Source

ip-interfaces.asd.

Parent Component

ip-interfaces (system).

Public Interface

filter-ip-interfaces-by-flags (function).
get-ip-interfaces (function).
get-ip-interfaces-by-flags (function).
ip-interface-address (reader).
(setf ip-interface-address) (writer).
ip-interface-address-family (reader).
(setf ip-interface-address-family) (writer).
ip-interface-broadcast-address (reader).
(setf ip-interface-broadcast-address) (writer).
ip-interface-flags (reader).
(setf ip-interface-flags) (writer).
ip-interface-name (reader).
(setf ip-interface-name) (writer).
ip-interface-netmask (reader).
(setf ip-interface-netmask) (writer).

Internals

bytes (function).
copy-ip-interface (function).
flag-value (function).
ip-interface (structure).
ip-interface-p (function).
make-ip-interface (function).

Next: Definitions, Previous: Files, Up: The ip-interfaces Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

ip-interfaces-asd
ip-interfaces

Next: ip-interfaces, Previous: Packages, Up: Packages [Contents][Index]

4.1 `ip-interfaces-asd`

Source

ip-interfaces.asd.

Use List

asdf/interface.
common-lisp.

Previous: ip-interfaces-asd, Up: Packages [Contents][Index]

4.2 `ip-interfaces`

Source

package.lisp.

Use List

cffi.
common-lisp.

Public Interface

filter-ip-interfaces-by-flags (function).
get-ip-interfaces (function).
get-ip-interfaces-by-flags (function).
ip-interface-address (reader).
(setf ip-interface-address) (writer).
ip-interface-address-family (reader).
(setf ip-interface-address-family) (writer).
ip-interface-broadcast-address (reader).
(setf ip-interface-broadcast-address) (writer).
ip-interface-flags (reader).
(setf ip-interface-flags) (writer).
ip-interface-name (reader).
(setf ip-interface-name) (writer).
ip-interface-netmask (reader).
(setf ip-interface-netmask) (writer).

Internals

bytes (function).
copy-ip-interface (function).
flag-value (function).
freeifaddrs (function).
getifaddrs (function).
ifaddrs-tclass (class).
ip-interface (structure).
ip-interface-p (function).
make-ip-interface (function).
sockaddr-tclass (class).

Next: Indexes, Previous: Packages, Up: The ip-interfaces Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

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

5.2 Internals

Ordinary functions
Structures
Classes

Next: Structures, Previous: Internals, Up: Internals [Contents][Index]

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.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

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).

Previous: Structures, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The ip-interfaces Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	A B F N S

	Index Entry	Section

A
	`address`:	Private structures
	`address-family`:	Private structures

B
	`broadcast-address`:	Private structures

F
	`flags`:	Private structures

N
	`name`:	Private structures
	`netmask`:	Private structures

S
	`Slot, address`:	Private structures
	`Slot, address-family`:	Private structures
	`Slot, broadcast-address`:	Private structures
	`Slot, flags`:	Private structures
	`Slot, name`:	Private structures
	`Slot, netmask`:	Private structures

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

A.4 Data types

Jump to:	C F I P S

	Index Entry	Section

C
	`Class, ifaddrs-tclass`:	Private classes
	`Class, sockaddr-tclass`:	Private classes

F
	`File, ip-interfaces.asd`:	The ip-interfaces/ip-interfaces․asd file
	`File, ip-interfaces.lisp`:	The ip-interfaces/ip-interfaces․lisp file
	`File, package.lisp`:	The ip-interfaces/package․lisp file
	`File, sockets.lisp`:	The ip-interfaces/sockets․lisp file

I
	`ifaddrs-tclass`:	Private classes
	`ip-interface`:	Private structures
	`ip-interfaces`:	The ip-interfaces system
	`ip-interfaces`:	The ip-interfaces package
	`ip-interfaces-asd`:	The ip-interfaces-asd package
	`ip-interfaces.asd`:	The ip-interfaces/ip-interfaces․asd file
	`ip-interfaces.lisp`:	The ip-interfaces/ip-interfaces․lisp file

P
	`Package, ip-interfaces`:	The ip-interfaces package
	`Package, ip-interfaces-asd`:	The ip-interfaces-asd package
	`package.lisp`:	The ip-interfaces/package․lisp file

S
	`sockaddr-tclass`:	Private classes
	`sockets.lisp`:	The ip-interfaces/sockets․lisp file
	`Structure, ip-interface`:	Private structures
	`System, ip-interfaces`:	The ip-interfaces system

The ip-interfaces Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 ip-interfaces

3 Files

3.1 Lisp

3.1.1 ip-interfaces/ip-interfaces.asd

3.1.2 ip-interfaces/package.lisp

3.1.3 ip-interfaces/sockets.lisp

3.1.4 ip-interfaces/ip-interfaces.lisp

4 Packages

4.1 ip-interfaces-asd

4.2 ip-interfaces

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Structures

5.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `ip-interfaces`

3.1.1 `ip-interfaces/ip-interfaces.asd`

3.1.2 `ip-interfaces/package.lisp`

3.1.3 `ip-interfaces/sockets.lisp`

3.1.4 `ip-interfaces/ip-interfaces.lisp`

4.1 `ip-interfaces-asd`

4.2 `ip-interfaces`