The ip-interfaces Reference Manual

Table of Contents

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

The ip-interfaces Reference Manual

This is the ip-interfaces Reference Manual, version 0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:01:57 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 ip-interfaces

Author

Elliott Slaughter <elliottslaughter@gmail.com>

License

LLGPL

Description

Query network interfaces on the local machine.

Version

0.0

Dependency

cffi

Source

ip-interfaces.asd (file)

Components

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 ip-interfaces.asd

Location

ip-interfaces.asd

Systems

ip-interfaces (system)

Packages

ip-interfaces-asd


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

2.1.2 ip-interfaces/package.lisp

Parent

ip-interfaces (system)

Location

package.lisp

Packages

ip-interfaces


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

2.1.3 ip-interfaces/sockets.lisp

Dependency

package.lisp (file)

Parent

ip-interfaces (system)

Location

sockets.lisp

Internal Definitions

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

2.1.4 ip-interfaces/ip-interfaces.lisp

Dependency

sockets.lisp (file)

Parent

ip-interfaces (system)

Location

ip-interfaces.lisp

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 ip-interfaces-asd

Source

ip-interfaces.asd

Use List

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

3.2 ip-interfaces

Source

package.lisp (file)

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


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

4.1.1 Functions

Function: filter-ip-interfaces-by-flags IP-INTERFACES FLAGS-TO-INCLUDE &optional FLAGS-TO-EXCLUDE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: get-ip-interfaces ()
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: get-ip-interfaces-by-flags FLAGS-TO-INCLUDE &optional FLAGS-TO-EXCLUDE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: ip-interface-address INSTANCE
Function: (setf ip-interface-address) VALUE INSTANCE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: ip-interface-address-family INSTANCE
Function: (setf ip-interface-address-family) VALUE INSTANCE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: ip-interface-broadcast-address INSTANCE
Function: (setf ip-interface-broadcast-address) VALUE INSTANCE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: ip-interface-flags INSTANCE
Function: (setf ip-interface-flags) VALUE INSTANCE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: ip-interface-name INSTANCE
Function: (setf ip-interface-name) VALUE INSTANCE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: ip-interface-netmask INSTANCE
Function: (setf ip-interface-netmask) VALUE INSTANCE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)


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

4.2 Internal definitions


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

4.2.1 Functions

Function: bytes POINTER COUNT
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: copy-ip-interface INSTANCE
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: flag-value FLAG
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: freeifaddrs IFADDRS
Package

ip-interfaces

Source

sockets.lisp (file)

Function: getifaddrs IFADDRS
Package

ip-interfaces

Source

sockets.lisp (file)

Function: ip-interface-p OBJECT
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Function: make-ip-interface &key (NAME NAME) (ADDRESS ADDRESS) (NETMASK NETMASK) (BROADCAST-ADDRESS BROADCAST-ADDRESS) (FLAGS FLAGS) (ADDRESS-FAMILY ADDRESS-FAMILY)
Package

ip-interfaces

Source

ip-interfaces.lisp (file)


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

4.2.2 Structures

Structure: ip-interface ()
Package

ip-interfaces

Source

ip-interfaces.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Readers

ip-interface-name (function)

Writers

(setf ip-interface-name) (function)

Slot: address
Readers

ip-interface-address (function)

Writers

(setf ip-interface-address) (function)

Slot: netmask
Readers

ip-interface-netmask (function)

Writers

(setf ip-interface-netmask) (function)

Slot: broadcast-address
Readers

ip-interface-broadcast-address (function)

Writers

(setf ip-interface-broadcast-address) (function)

Slot: flags
Readers

ip-interface-flags (function)

Writers

(setf ip-interface-flags) (function)

Slot: address-family
Readers

ip-interface-address-family (function)

Writers

(setf ip-interface-address-family) (function)


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

4.2.3 Classes

Class: ifaddrs-tclass ()
Package

ip-interfaces

Source

sockets.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: sockaddr-tclass ()
Package

ip-interfaces

Source

sockets.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   I   L  
Index Entry  Section

F
File, Lisp, ip-interfaces.asd: The ip-interfaces<dot>asd file
File, Lisp, ip-interfaces/ip-interfaces.lisp: The ip-interfaces/ip-interfaces<dot>lisp file
File, Lisp, ip-interfaces/package.lisp: The ip-interfaces/package<dot>lisp file
File, Lisp, ip-interfaces/sockets.lisp: The ip-interfaces/sockets<dot>lisp file

I
ip-interfaces.asd: The ip-interfaces<dot>asd file
ip-interfaces/ip-interfaces.lisp: The ip-interfaces/ip-interfaces<dot>lisp file
ip-interfaces/package.lisp: The ip-interfaces/package<dot>lisp file
ip-interfaces/sockets.lisp: The ip-interfaces/sockets<dot>lisp file

L
Lisp File, ip-interfaces.asd: The ip-interfaces<dot>asd file
Lisp File, ip-interfaces/ip-interfaces.lisp: The ip-interfaces/ip-interfaces<dot>lisp file
Lisp File, ip-interfaces/package.lisp: The ip-interfaces/package<dot>lisp file
Lisp File, ip-interfaces/sockets.lisp: The ip-interfaces/sockets<dot>lisp file

Jump to:   F   I   L  

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

A.2 Functions

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

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

B
bytes: Internal functions

C
copy-ip-interface: Internal functions

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

G
get-ip-interfaces: Exported functions
get-ip-interfaces-by-flags: Exported functions
getifaddrs: Internal functions

I
ip-interface-address: Exported functions
ip-interface-address-family: Exported functions
ip-interface-broadcast-address: Exported functions
ip-interface-flags: Exported functions
ip-interface-name: Exported functions
ip-interface-netmask: Exported functions
ip-interface-p: Internal functions

M
make-ip-interface: Internal functions

Jump to:   (  
B   C   F   G   I   M  

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

A.3 Variables

Jump to:   A   B   F   N   S  
Index Entry  Section

A
address: Internal structures
address-family: Internal structures

B
broadcast-address: Internal structures

F
flags: Internal structures

N
name: Internal structures
netmask: Internal structures

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

Jump to:   A   B   F   N   S  

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

A.4 Data types

Jump to:   C   I   P   S  
Index Entry  Section

C
Class, ifaddrs-tclass: Internal classes
Class, sockaddr-tclass: Internal classes

I
ifaddrs-tclass: Internal classes
ip-interface: Internal structures
ip-interfaces: The ip-interfaces system
ip-interfaces: The ip-interfaces package
ip-interfaces-asd: The ip-interfaces-asd package

P
Package, ip-interfaces: The ip-interfaces package
Package, ip-interfaces-asd: The ip-interfaces-asd package

S
sockaddr-tclass: Internal classes
Structure, ip-interface: Internal structures
System, ip-interfaces: The ip-interfaces system

Jump to:   C   I   P   S