The hu.dwim.bluez Reference Manual

This is the hu.dwim.bluez Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:42:10 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 hu.dwim.bluez

Common Lisp FFI wrapper for libbluetooth, aka Bluez, which is a Linux Bluetooth stack.

Author

Attila Lendvai

License

BSD or Bugroff

Version

0.1

Defsystem Dependency

cffi/c2ffi (system).

Dependencies
  • alexandria (system).
  • cffi (system).
  • cffi/c2ffi (system).
  • cffi-libffi (system).
Source

hu.dwim.bluez.asd.

Child Components

3 Modules

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


3.1 hu.dwim.bluez/source

Dependencies
Source

hu.dwim.bluez.asd.

Parent Component

hu.dwim.bluez (system).

Child Components

3.2 hu.dwim.bluez/c2ffi-spec

Dependencies
Source

hu.dwim.bluez.asd.

Parent Component

hu.dwim.bluez (system).

Child Component

bluez.h (file).


4 Files

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


4.1 Lisp


4.1.1 hu.dwim.bluez/hu.dwim.bluez.asd

Source

hu.dwim.bluez.asd.

Parent Component

hu.dwim.bluez (system).

ASDF Systems

hu.dwim.bluez.


4.1.2 hu.dwim.bluez/package-stage-1.lisp

Source

hu.dwim.bluez.asd.

Parent Component

hu.dwim.bluez (system).

Packages

hu.dwim.bluez.


4.1.3 hu.dwim.bluez/ffi-prelude.lisp

Dependency

package-stage-1.lisp (file).

Source

hu.dwim.bluez.asd.

Parent Component

hu.dwim.bluez (system).

Public Interface

expand-from-foreign (method).

Internals

4.1.4 hu.dwim.bluez/source/package-stage-2.lisp

Source

hu.dwim.bluez.asd.

Parent Component

source (module).

Internals

import-all-owned-symbols (function).


4.1.5 hu.dwim.bluez/source/package-stage-3.lisp

Dependency

package-stage-2.lisp (file).

Source

hu.dwim.bluez.asd.

Parent Component

source (module).


4.1.6 hu.dwim.bluez/source/bluez.lisp

Dependency

package-stage-3.lisp (file).

Source

hu.dwim.bluez.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.7 hu.dwim.bluez/c2ffi-spec/bluez.h

Source

hu.dwim.bluez.asd.

Parent Component

c2ffi-spec (module).


5 Packages

Packages are listed by definition order.


5.1 hu.dwim.bluez

Source

package-stage-1.lisp.

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

6 Definitions

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


6.1 Public Interface


6.1.1 Constants

Constant: +eir-device-id+

device ID

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-flags+
Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-name-complete+

complete local name

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-name-short+

shortened local name

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-tx-power+

transmit power level

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-uuid128-all+

128-bit UUID, all listed

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-uuid128-some+

128-bit UUID, more available

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-uuid16-all+

16-bit UUID, all listed

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-uuid16-some+

16-bit UUID, more available

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-uuid32-all+

32-bit UUID, all listed

Package

hu.dwim.bluez.

Source

bluez.lisp.

Constant: +eir-uuid32-some+

32-bit UUID, more available

Package

hu.dwim.bluez.

Source

bluez.lisp.


6.1.2 Macros

Macro: c-fun/rc (fn-name &rest args)
Package

hu.dwim.bluez.

Source

bluez.lisp.


6.1.3 Ordinary functions

Function: bdaddr->string (bdaddr)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: (setf fd-nonblocking-p) (fd)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci-filter/clear (filter)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci-filter/initialize-for-le-scanning (filter)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci-filter/set-event (event filter)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci-filter/set-ptype (type filter)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci/adapter-name (device-id)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci/is-device-le-capable? (device-id)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci/reset-adapter (device-id)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: parse-extended-inquiry-response (eir eir-length)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: string->bdaddr (str bdaddr)
Package

hu.dwim.bluez.

Source

bluez.lisp.


6.1.4 Standalone methods

Method: expand-from-foreign (value (type hci-return-code))
Package

cffi.

Source

ffi-prelude.lisp.


6.1.5 Types

Type: hci/device-id ()
Package

hu.dwim.bluez.

Source

bluez.lisp.


6.2 Internals


6.2.1 Symbol macros

Symbol Macro: *errno*
Package

hu.dwim.bluez.

Source

bluez.lisp.


6.2.2 Macros

Macro: c-fun (fn-name &rest args)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Macro: c-ref (object type slot)
Package

hu.dwim.bluez.

Source

bluez.lisp.


6.2.3 Ordinary functions

Function: %c-fun/rc/check-error (rc fn-name whole-form)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: %errno-location ()
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: %strerror (errno)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: copy-sap-to-byte-vector (pointer size)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: ffi-type-transformer (type context &rest args &key &allow-other-keys)
Package

hu.dwim.bluez.

Source

ffi-prelude.lisp.

Function: hci/bringup-device (socket device-id)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: hci/shutdown-device (socket device-id)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: htob/128 (value)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: htob/16 (value)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: htob/32 (value)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: htob/64 (value)
Package

hu.dwim.bluez.

Source

bluez.lisp.

Function: import-all-owned-symbols (source-package target-package &key overwrite)
Package

hu.dwim.bluez.

Source

package-stage-2.lisp.

Function: strerror (&optional errno)
Package

hu.dwim.bluez.

Source

bluez.lisp.


6.2.4 Generic functions

Generic Reader: error-code-of (condition)
Generic Writer: (setf error-code-of) (condition)
Package

hu.dwim.bluez.

Methods
Reader Method: error-code-of ((condition hci-error/negative-return-code))
Writer Method: (setf error-code-of) ((condition hci-error/negative-return-code))
Source

ffi-prelude.lisp.

Target Slot

error-code.


6.2.5 Conditions

Condition: bluez-error
Package

hu.dwim.bluez.

Source

ffi-prelude.lisp.

Direct superclasses

error.

Direct subclasses

hci-error.

Condition: hci-error
Package

hu.dwim.bluez.

Source

ffi-prelude.lisp.

Direct superclasses

bluez-error.

Direct subclasses

hci-error/negative-return-code.

Condition: hci-error/negative-return-code
Package

hu.dwim.bluez.

Source

ffi-prelude.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: error-code
Initform

(quote (error "must specify error-code."))

Initargs

:error-code

Readers

error-code-of.

Writers

(setf error-code-of).


6.2.6 Classes

Class: hci-return-code
Package

hu.dwim.bluez.

Source

ffi-prelude.lisp.

Direct superclasses

foreign-type-alias.

Direct methods

expand-from-foreign.

Direct Default Initargs
InitargValue
:actual-type(parse-type int)

6.2.7 Types

Type: fd ()
Package

hu.dwim.bluez.

Source

bluez.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
B   C   E   F   G   H   I   M   P   S  
Index Entry  Section

%
%c-fun/rc/check-error: Private ordinary functions
%errno-location: Private ordinary functions
%strerror: Private ordinary functions

(
(setf error-code-of): Private generic functions
(setf error-code-of): Private generic functions
(setf fd-nonblocking-p): Public ordinary functions

B
bdaddr->string: Public ordinary functions

C
c-fun: Private macros
c-fun/rc: Public macros
c-ref: Private macros
copy-sap-to-byte-vector: Private ordinary functions

E
error-code-of: Private generic functions
error-code-of: Private generic functions
expand-from-foreign: Public standalone methods

F
ffi-type-transformer: Private ordinary functions
Function, %c-fun/rc/check-error: Private ordinary functions
Function, %errno-location: Private ordinary functions
Function, %strerror: Private ordinary functions
Function, (setf fd-nonblocking-p): Public ordinary functions
Function, bdaddr->string: Public ordinary functions
Function, copy-sap-to-byte-vector: Private ordinary functions
Function, ffi-type-transformer: Private ordinary functions
Function, hci-filter/clear: Public ordinary functions
Function, hci-filter/initialize-for-le-scanning: Public ordinary functions
Function, hci-filter/set-event: Public ordinary functions
Function, hci-filter/set-ptype: Public ordinary functions
Function, hci/adapter-name: Public ordinary functions
Function, hci/bringup-device: Private ordinary functions
Function, hci/is-device-le-capable?: Public ordinary functions
Function, hci/reset-adapter: Public ordinary functions
Function, hci/shutdown-device: Private ordinary functions
Function, htob/128: Private ordinary functions
Function, htob/16: Private ordinary functions
Function, htob/32: Private ordinary functions
Function, htob/64: Private ordinary functions
Function, import-all-owned-symbols: Private ordinary functions
Function, parse-extended-inquiry-response: Public ordinary functions
Function, strerror: Private ordinary functions
Function, string->bdaddr: Public ordinary functions

G
Generic Function, (setf error-code-of): Private generic functions
Generic Function, error-code-of: Private generic functions

H
hci-filter/clear: Public ordinary functions
hci-filter/initialize-for-le-scanning: Public ordinary functions
hci-filter/set-event: Public ordinary functions
hci-filter/set-ptype: Public ordinary functions
hci/adapter-name: Public ordinary functions
hci/bringup-device: Private ordinary functions
hci/is-device-le-capable?: Public ordinary functions
hci/reset-adapter: Public ordinary functions
hci/shutdown-device: Private ordinary functions
htob/128: Private ordinary functions
htob/16: Private ordinary functions
htob/32: Private ordinary functions
htob/64: Private ordinary functions

I
import-all-owned-symbols: Private ordinary functions

M
Macro, c-fun: Private macros
Macro, c-fun/rc: Public macros
Macro, c-ref: Private macros
Method, (setf error-code-of): Private generic functions
Method, error-code-of: Private generic functions
Method, expand-from-foreign: Public standalone methods

P
parse-extended-inquiry-response: Public ordinary functions

S
strerror: Private ordinary functions
string->bdaddr: Public ordinary functions


A.4 Data types

Jump to:   B   C   F   H   M   P   S   T  
Index Entry  Section

B
bluez-error: Private conditions
bluez.h: The hu․dwim․bluez/c2ffi-spec/bluez․h file
bluez.lisp: The hu․dwim․bluez/source/bluez․lisp file

C
c2ffi-spec: The hu․dwim․bluez/c2ffi-spec module
Class, hci-return-code: Private classes
Condition, bluez-error: Private conditions
Condition, hci-error: Private conditions
Condition, hci-error/negative-return-code: Private conditions

F
fd: Private types
ffi-prelude.lisp: The hu․dwim․bluez/ffi-prelude․lisp file
File, bluez.h: The hu․dwim․bluez/c2ffi-spec/bluez․h file
File, bluez.lisp: The hu․dwim․bluez/source/bluez․lisp file
File, ffi-prelude.lisp: The hu․dwim․bluez/ffi-prelude․lisp file
File, hu.dwim.bluez.asd: The hu․dwim․bluez/hu․dwim․bluez․asd file
File, package-stage-1.lisp: The hu․dwim․bluez/package-stage-1․lisp file
File, package-stage-2.lisp: The hu․dwim․bluez/source/package-stage-2․lisp file
File, package-stage-3.lisp: The hu․dwim․bluez/source/package-stage-3․lisp file

H
hci-error: Private conditions
hci-error/negative-return-code: Private conditions
hci-return-code: Private classes
hci/device-id: Public types
hu.dwim.bluez: The hu․dwim․bluez system
hu.dwim.bluez: The hu․dwim․bluez package
hu.dwim.bluez.asd: The hu․dwim․bluez/hu․dwim․bluez․asd file

M
Module, c2ffi-spec: The hu․dwim․bluez/c2ffi-spec module
Module, source: The hu․dwim․bluez/source module

P
Package, hu.dwim.bluez: The hu․dwim․bluez package
package-stage-1.lisp: The hu․dwim․bluez/package-stage-1․lisp file
package-stage-2.lisp: The hu․dwim․bluez/source/package-stage-2․lisp file
package-stage-3.lisp: The hu․dwim․bluez/source/package-stage-3․lisp file

S
source: The hu․dwim․bluez/source module
System, hu.dwim.bluez: The hu․dwim․bluez system

T
Type, fd: Private types
Type, hci/device-id: Public types