The cl-geoip Reference Manual

This is the cl-geoip Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:16:24 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-geoip

Wrapper around libGeoIP

License

WTFPL 2.0

Dependency

cffi (system).

Source

cl-geoip.asd.

Child Component

geoip.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 cl-geoip/cl-geoip.asd

Source

cl-geoip.asd.

Parent Component

cl-geoip (system).

ASDF Systems

cl-geoip.


3.1.2 cl-geoip/geoip.lisp

Source

cl-geoip.asd.

Parent Component

cl-geoip (system).

Packages

geoip.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 geoip

Source

geoip.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: get-country-code (ip)
Package

geoip.

Source

geoip.lisp.

Function: open-databases (ip4 ip6)
Package

geoip.

Source

geoip.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *ip4-db*
Package

geoip.

Source

geoip.lisp.

Special Variable: *ip6-db*
Package

geoip.

Source

geoip.lisp.


5.2.2 Ordinary functions

Function: geoip-country-code-by-addr (database ip-4)
Package

geoip.

Source

geoip.lisp.

Function: geoip-country-code-by-addr-v6 (database ip-6)
Package

geoip.

Source

geoip.lisp.

Function: geoip-open (filename flags)
Package

geoip.

Source

geoip.lisp.


Appendix A Indexes


A.1 Concepts