The network-addresses Reference Manual

This is the network-addresses Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:08:38 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 network-addresses

A network addresses manipulation library.

Author

Florian Margaine <>

License

MIT

Dependency

cl-ppcre (system).

Source

network-addresses.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 network-addresses/src

Source

network-addresses.asd.

Parent Component

network-addresses (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 network-addresses/network-addresses.asd

Source

network-addresses.asd.

Parent Component

network-addresses (system).

ASDF Systems

network-addresses.


4.1.2 network-addresses/src/package.lisp

Source

network-addresses.asd.

Parent Component

src (module).

Packages

4.1.3 network-addresses/src/generic.lisp

Dependency

package.lisp (file).

Source

network-addresses.asd.

Parent Component

src (module).

Public Interface

as-str (generic function).


4.1.4 network-addresses/src/conditions.lisp

Dependency

package.lisp (file).

Source

network-addresses.asd.

Parent Component

src (module).

Public Interface

invalid-format (condition).


4.1.5 network-addresses/src/address.lisp

Dependency

package.lisp (file).

Source

network-addresses.asd.

Parent Component

src (module).

Public Interface

4.1.6 network-addresses/src/network.lisp

Dependencies
Source

network-addresses.asd.

Parent Component

src (module).

Public Interface
Internals

range (function).


4.1.7 network-addresses/src/ipv4.lisp

Dependencies
Source

network-addresses.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 network-addresses-ipv4

Source

package.lisp.

Nickname

na4

Use List

common-lisp.

Public Interface

make-network-from-cidr (function).

Internals

5.2 network-addresses

Source

package.lisp.

Nickname

na

Use List

common-lisp.

Public Interface
Internals

range (function).


6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: addresses-int (network)

Returns the list of IP addresses of a network as integers.

Package

network-addresses.

Source

network.lisp.

Function: broadcast-int (network)

Returns the broadcast as an integer.

Package

network-addresses.

Source

network.lisp.

Function: first-address-int (network)

Returns the first address of this network.

Package

network-addresses.

Source

network.lisp.

Function: hostmask-int (network)

Returns the hostmask as an integer.

Package

network-addresses.

Source

network.lisp.

Function: last-address-int (network)

Returns the last address of this network.

Package

network-addresses.

Source

network.lisp.

Function: make-network-from-cidr (cidr)

Return a IPv4 network object based on the cidr.

Package

network-addresses-ipv4.

Source

ipv4.lisp.

Function: netmask-int (network)

Returns the netmask as an integer.

Package

network-addresses.

Source

network.lisp.


6.1.2 Generic functions

Generic Function: addresses (network)

Returns the list of IP addresses of a network.

Package

network-addresses.

Source

network.lisp.

Methods
Method: addresses ((network ipv4-network))
Source

ipv4.lisp.

Generic Reader: as-int (object)
Package

network-addresses.

Methods
Reader Method: as-int ((network network))

automatically generated reader method

Source

network.lisp.

Target Slot

integer-value.

Reader Method: as-int ((address address))

automatically generated reader method

Source

address.lisp.

Target Slot

integer-value.

Generic Function: as-str (object)

Returns the IP address/network in its string representation.

Package

network-addresses.

Source

generic.lisp.

Methods
Method: as-str ((network ipv4-network))
Source

ipv4.lisp.

Method: as-str ((address ipv4-address))
Source

ipv4.lisp.

Generic Function: broadcast (network)

Returns the broadcast as an IP address.

Package

network-addresses.

Source

network.lisp.

Methods
Method: broadcast ((network ipv4-network))
Source

ipv4.lisp.

Generic Function: first-address (network)

Returns the first IP address of this network.

Package

network-addresses.

Source

network.lisp.

Methods
Method: first-address ((network ipv4-network))
Source

ipv4.lisp.

Generic Function: hostmask (network)

Returns the hostmask as an IP address.

Package

network-addresses.

Source

network.lisp.

Methods
Method: hostmask ((network ipv4-network))
Source

ipv4.lisp.

Generic Function: last-address (network)

Returns the last IP address of this network.

Package

network-addresses.

Source

network.lisp.

Methods
Method: last-address ((network ipv4-network))
Source

ipv4.lisp.

Generic Reader: max-value (object)
Package

network-addresses.

Methods
Reader Method: max-value ((ipv4-network ipv4-network))

automatically generated reader method

Source

ipv4.lisp.

Target Slot

max-value.

Reader Method: max-value ((network network))

automatically generated reader method

Source

network.lisp.

Target Slot

max-value.

Generic Function: netmask (network)

Returns the netmask as an IP address.

Package

network-addresses.

Source

network.lisp.

Methods
Method: netmask ((network ipv4-network))
Source

ipv4.lisp.

Generic Reader: subnet-length (object)
Package

network-addresses.

Methods
Reader Method: subnet-length ((network network))

automatically generated reader method

Source

network.lisp.

Target Slot

subnet-length.

Generic Reader: width (object)
Package

network-addresses.

Methods
Reader Method: width ((ipv4-network ipv4-network))

automatically generated reader method

Source

ipv4.lisp.

Target Slot

width.

Reader Method: width ((network network))

automatically generated reader method

Source

network.lisp.

Target Slot

width.


6.1.3 Standalone methods

Method: initialize-instance :after ((network ipv4-network) &key)
Source

ipv4.lisp.

Method: print-object ((address ipv4-address) out)
Source

ipv4.lisp.

Method: print-object ((network ipv4-network) out)
Source

ipv4.lisp.


6.1.4 Conditions

Condition: invalid-format
Package

network-addresses.

Source

conditions.lisp.

Direct superclasses

error.


6.1.5 Classes

Class: address
Package

network-addresses.

Source

address.lisp.

Direct subclasses

ipv4-address.

Direct methods

as-int.

Direct slots
Slot: integer-value
Initargs

:integer-value

Readers

as-int.

Writers

This slot is read-only.

Class: network
Package

network-addresses.

Source

network.lisp.

Direct subclasses

ipv4-network.

Direct methods
Direct slots
Slot: integer-value
Initargs

:integer-value

Readers

as-int.

Writers

This slot is read-only.

Slot: subnet-length
Initargs

:subnet-length

Readers

subnet-length.

Writers

This slot is read-only.

Slot: width
Initform

(error "not implemented.")

Readers

width.

Writers

This slot is read-only.

Slot: max-value
Initform

(error "not implemented.")

Readers

max-value.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: *ipv4-cidr-regex*
Package

network-addresses-ipv4.

Source

ipv4.lisp.


6.2.2 Ordinary functions

Function: ipv4-integers-to-integer (strings)

Transforms a list of integers in strings into a single integer, by having each integer going through its byte representation, then concatenating all the bytes, and returning the value of these bits. With math.

Package

network-addresses-ipv4.

Source

ipv4.lisp.

Function: range (start end)
Package

network-addresses.

Source

network.lisp.


6.2.3 Classes

Class: ipv4-address
Package

network-addresses-ipv4.

Source

ipv4.lisp.

Direct superclasses

address.

Direct methods
Class: ipv4-network
Package

network-addresses-ipv4.

Source

ipv4.lisp.

Direct superclasses

network.

Direct methods
Direct slots
Slot: width
Package

network-addresses.

Initform

32

Readers

width.

Writers

This slot is read-only.

Slot: max-value
Package

network-addresses.

Initform

4294967295

Readers

max-value.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   B   F   G   H   I   L   M   N   P   R   S   W  
Index Entry  Section

A
addresses: Public generic functions
addresses: Public generic functions
addresses-int: Public ordinary functions
as-int: Public generic functions
as-int: Public generic functions
as-int: Public generic functions
as-str: Public generic functions
as-str: Public generic functions
as-str: Public generic functions

B
broadcast: Public generic functions
broadcast: Public generic functions
broadcast-int: Public ordinary functions

F
first-address: Public generic functions
first-address: Public generic functions
first-address-int: Public ordinary functions
Function, addresses-int: Public ordinary functions
Function, broadcast-int: Public ordinary functions
Function, first-address-int: Public ordinary functions
Function, hostmask-int: Public ordinary functions
Function, ipv4-integers-to-integer: Private ordinary functions
Function, last-address-int: Public ordinary functions
Function, make-network-from-cidr: Public ordinary functions
Function, netmask-int: Public ordinary functions
Function, range: Private ordinary functions

G
Generic Function, addresses: Public generic functions
Generic Function, as-int: Public generic functions
Generic Function, as-str: Public generic functions
Generic Function, broadcast: Public generic functions
Generic Function, first-address: Public generic functions
Generic Function, hostmask: Public generic functions
Generic Function, last-address: Public generic functions
Generic Function, max-value: Public generic functions
Generic Function, netmask: Public generic functions
Generic Function, subnet-length: Public generic functions
Generic Function, width: Public generic functions

H
hostmask: Public generic functions
hostmask: Public generic functions
hostmask-int: Public ordinary functions

I
initialize-instance: Public standalone methods
ipv4-integers-to-integer: Private ordinary functions

L
last-address: Public generic functions
last-address: Public generic functions
last-address-int: Public ordinary functions

M
make-network-from-cidr: Public ordinary functions
max-value: Public generic functions
max-value: Public generic functions
max-value: Public generic functions
Method, addresses: Public generic functions
Method, as-int: Public generic functions
Method, as-int: Public generic functions
Method, as-str: Public generic functions
Method, as-str: Public generic functions
Method, broadcast: Public generic functions
Method, first-address: Public generic functions
Method, hostmask: Public generic functions
Method, initialize-instance: Public standalone methods
Method, last-address: Public generic functions
Method, max-value: Public generic functions
Method, max-value: Public generic functions
Method, netmask: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, subnet-length: Public generic functions
Method, width: Public generic functions
Method, width: Public generic functions

N
netmask: Public generic functions
netmask: Public generic functions
netmask-int: Public ordinary functions

P
print-object: Public standalone methods
print-object: Public standalone methods

R
range: Private ordinary functions

S
subnet-length: Public generic functions
subnet-length: Public generic functions

W
width: Public generic functions
width: Public generic functions
width: Public generic functions


A.4 Data types

Jump to:   A   C   F   G   I   M   N   P   S  
Index Entry  Section

A
address: Public classes
address.lisp: The network-addresses/src/address․lisp file

C
Class, address: Public classes
Class, ipv4-address: Private classes
Class, ipv4-network: Private classes
Class, network: Public classes
Condition, invalid-format: Public conditions
conditions.lisp: The network-addresses/src/conditions․lisp file

F
File, address.lisp: The network-addresses/src/address․lisp file
File, conditions.lisp: The network-addresses/src/conditions․lisp file
File, generic.lisp: The network-addresses/src/generic․lisp file
File, ipv4.lisp: The network-addresses/src/ipv4․lisp file
File, network-addresses.asd: The network-addresses/network-addresses․asd file
File, network.lisp: The network-addresses/src/network․lisp file
File, package.lisp: The network-addresses/src/package․lisp file

G
generic.lisp: The network-addresses/src/generic․lisp file

I
invalid-format: Public conditions
ipv4-address: Private classes
ipv4-network: Private classes
ipv4.lisp: The network-addresses/src/ipv4․lisp file

M
Module, src: The network-addresses/src module

N
network: Public classes
network-addresses: The network-addresses system
network-addresses: The network-addresses package
network-addresses-ipv4: The network-addresses-ipv4 package
network-addresses.asd: The network-addresses/network-addresses․asd file
network.lisp: The network-addresses/src/network․lisp file

P
Package, network-addresses: The network-addresses package
Package, network-addresses-ipv4: The network-addresses-ipv4 package
package.lisp: The network-addresses/src/package․lisp file

S
src: The network-addresses/src module
System, network-addresses: The network-addresses system