Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the dbus Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:24:54 2022 GMT+0.
Next: Systems, Previous: The dbus Reference Manual, Up: The dbus Reference Manual [Contents][Index]
DBUS - A D-BUS client library for Common Lisp Prerequisites: Alexandria Babel CL-XmlSpam Flexi-Streams IOLib Ironclad Split-Sequence Trivial-Garbage IEEE-Floats
Next: Files, Previous: Introduction, Up: The dbus Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
A D-BUS client library for Common Lisp
death
BSD
asdf-package-system (system).
dbus/all (system).
Next: dbus/utils, Previous: dbus, Up: Systems [Contents][Index]
death
BSD
Next: dbus/protocols, Previous: dbus/all, Up: Systems [Contents][Index]
death
BSD
Next: dbus/conditions, Previous: dbus/utils, Up: Systems [Contents][Index]
death
BSD
Next: dbus/types, Previous: dbus/protocols, Up: Systems [Contents][Index]
death
BSD
Next: dbus/type-definitions, Previous: dbus/conditions, Up: Systems [Contents][Index]
death
BSD
Next: dbus/messages, Previous: dbus/types, Up: Systems [Contents][Index]
death
BSD
Next: dbus/server-addresses, Previous: dbus/type-definitions, Up: Systems [Contents][Index]
death
BSD
Next: dbus/authentication-mechanisms, Previous: dbus/messages, Up: Systems [Contents][Index]
death
BSD
Next: dbus/connections, Previous: dbus/server-addresses, Up: Systems [Contents][Index]
death
BSD
Next: dbus/introspect, Previous: dbus/authentication-mechanisms, Up: Systems [Contents][Index]
death
BSD
Next: dbus/convenience, Previous: dbus/connections, Up: Systems [Contents][Index]
death
BSD
Next: dbus/publish, Previous: dbus/introspect, Up: Systems [Contents][Index]
death
BSD
Next: dbus/transport-unix, Previous: dbus/convenience, Up: Systems [Contents][Index]
death
BSD
Next: dbus/auth-dbus-cookie-sha1, Previous: dbus/publish, Up: Systems [Contents][Index]
death
BSD
Next: dbus/auth-dbus-external, Previous: dbus/transport-unix, Up: Systems [Contents][Index]
death
BSD
Previous: dbus/auth-dbus-cookie-sha1, Up: Systems [Contents][Index]
death
BSD
Next: Packages, Previous: Systems, Up: The dbus Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: dbus/all/file-type.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
dbus (system).
Next: dbus/utils/file-type.lisp, Previous: dbus/dbus.asd, Up: Lisp [Contents][Index]
Next: dbus/protocols/file-type.lisp, Previous: dbus/all/file-type.lisp, Up: Lisp [Contents][Index]
dbus/utils (system).
Next: dbus/conditions/file-type.lisp, Previous: dbus/utils/file-type.lisp, Up: Lisp [Contents][Index]
dbus/protocols (system).
Next: dbus/types/file-type.lisp, Previous: dbus/protocols/file-type.lisp, Up: Lisp [Contents][Index]
dbus/conditions (system).
Next: dbus/type-definitions/file-type.lisp, Previous: dbus/conditions/file-type.lisp, Up: Lisp [Contents][Index]
dbus/types (system).
Next: dbus/messages/file-type.lisp, Previous: dbus/types/file-type.lisp, Up: Lisp [Contents][Index]
dbus/type-definitions (system).
Next: dbus/server-addresses/file-type.lisp, Previous: dbus/type-definitions/file-type.lisp, Up: Lisp [Contents][Index]
dbus/messages (system).
Next: dbus/authentication-mechanisms/file-type.lisp, Previous: dbus/messages/file-type.lisp, Up: Lisp [Contents][Index]
dbus/server-addresses (system).
Next: dbus/connections/file-type.lisp, Previous: dbus/server-addresses/file-type.lisp, Up: Lisp [Contents][Index]
dbus/authentication-mechanisms (system).
Next: dbus/introspect/file-type.lisp, Previous: dbus/authentication-mechanisms/file-type.lisp, Up: Lisp [Contents][Index]
dbus/connections (system).
Next: dbus/convenience/file-type.lisp, Previous: dbus/connections/file-type.lisp, Up: Lisp [Contents][Index]
dbus/introspect (system).
Next: dbus/publish/file-type.lisp, Previous: dbus/introspect/file-type.lisp, Up: Lisp [Contents][Index]
dbus/convenience (system).
call-with-open-bus (function).
Next: dbus/transport-unix/file-type.lisp, Previous: dbus/convenience/file-type.lisp, Up: Lisp [Contents][Index]
dbus/publish (system).
Next: dbus/auth-dbus-cookie-sha1/file-type.lisp, Previous: dbus/publish/file-type.lisp, Up: Lisp [Contents][Index]
dbus/transport-unix (system).
server-address-socket-address (reader method).
Next: dbus/auth-dbus-external/file-type.lisp, Previous: dbus/transport-unix/file-type.lisp, Up: Lisp [Contents][Index]
dbus/auth-dbus-cookie-sha1 (system).
Previous: dbus/auth-dbus-cookie-sha1/file-type.lisp, Up: Lisp [Contents][Index]
dbus/auth-dbus-external (system).
Next: Definitions, Previous: Files, Up: The dbus Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: dbus/auth-dbus-external, Previous: Packages, Up: Packages [Contents][Index]
common-lisp.
Next: dbus/authentication-mechanisms, Previous: dbus/protocols, Up: Packages [Contents][Index]
Next: dbus/all, Previous: dbus/auth-dbus-external, Up: Packages [Contents][Index]
Next: dbus/types, Previous: dbus/authentication-mechanisms, Up: Packages [Contents][Index]
DBUS toplevel package.
dbus
Next: dbus/transport-unix, Previous: dbus/all, Up: Packages [Contents][Index]
Next: dbus/connections, Previous: dbus/types, Up: Packages [Contents][Index]
server-address-socket-address (generic reader).
Next: dbus/publish, Previous: dbus/transport-unix, Up: Packages [Contents][Index]
Next: dbus/messages, Previous: dbus/connections, Up: Packages [Contents][Index]
Next: dbus/utils, Previous: dbus/publish, Up: Packages [Contents][Index]
Next: dbus/conditions, Previous: dbus/messages, Up: Packages [Contents][Index]
common-lisp.
Next: dbus/convenience, Previous: dbus/utils, Up: Packages [Contents][Index]
common-lisp.
Next: dbus/server-addresses, Previous: dbus/conditions, Up: Packages [Contents][Index]
call-with-open-bus (function).
Next: dbus/auth-dbus-cookie-sha1, Previous: dbus/convenience, Up: Packages [Contents][Index]
Next: dbus/type-definitions, Previous: dbus/server-addresses, Up: Packages [Contents][Index]
Next: dbus/introspect, Previous: dbus/auth-dbus-cookie-sha1, Up: Packages [Contents][Index]
Previous: dbus/type-definitions, Up: Packages [Contents][Index]
Next: Indexes, Previous: Packages, Up: The dbus Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Special variables, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Macros, Previous: Constants, Up: Public Interface [Contents][Index]
Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]
Define an interface for mapping names (strings) to classes (or class names).
Evaluate forms with functions to read binary data from the stream
in a given endianness.
STREAM
A form evaluating to a binary input stream.
ENDIANNESS
A form evaluating to either :LITTLE-ENDIAN or :BIG-ENDIAN.
PREFIX
Either NIL (the default) or a string designator. In the latter
case, the following function names will be symbols interned in the
current package, with <PREFIX>-<NAME> names, e.g., INPUT-U8 if
the prefix is INPUT.
Local functions:
ALIGN
A function that takes an integer and ensures the stream’s read
position is aligned to it. It does so by reading and ignoring the
appropriate number of octets.
U8, U16, U32, U64
Functions that read 8-, 16-, 32-, and 64-bit unsigned byte values, respectively, from the stream, in the appropriate endianness. The read position is ensured to be naturally aligned before reading the value.
Evaluate forms with functions to write binary data to the stream in
a given endianness.
STREAM
A form evaluating to a binary output stream with a file position.
ENDIANNESS
A form evaluating to either :LITTLE-ENDIAN or :BIG-ENDIAN.
PREFIX
Either NIL (the default) or a string designator. In the latter
case, the following function names will be symbols interned in the
current package, with <PREFIX>-<NAME> names, e.g., OUTPUT-U8 if
the prefix is OUTPUT.
Local functions:
ALIGN
A function that takes an integer and ensures the stream’s file
position is aligned to it. It does so by writing the appropriate
number of 0 octets.
U8, U16, U32, U64
Functions that take 8-, 16-, 32-, and 64-bit unsigned byte values, respectively, and write these values to the stream, in the appropriate endianness. The values are always naturally aligned before written.
Sugar for CALL-WITH-IF-FAILED-HANDLER.
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
Invokes AddMatch bus method. Valid parameters are:
:type (:signal, :method-call, :method-return, :error)
:sender bus-name
:interface interface-name
:member (method-name, symbol-name)
:path object-path
:path-namespace object-path
:destination unique-name
:argN [N=0~63] string
Return the current user’s name.
Decode a string composed of hexadecimal digit character pairs, each
representing an octet, to an octet vector with the corresponding
octets.
START and END are bounding index designators for the string.
Decode a DBUS message from the stream.
If there are no bytes to be read from the stream, the function
immediately returns NIL. Otherwise, the function performs blocking
reads until a complete message is decoded. If an end of file occurs,
an error of type END-OF-FILE is signaled.
Unfortunately, due to Common Lisp not having a READ-BYTE-NO-HANG operator, the stream has to be a bivalent stream.
Encode a string composed of hexadecimal digit character pairs, each
representing an octet. The input is either an octet vector, or a
UTF-8 string that will be converted to one.
START and END are bounding index designators for the data.
Encode a DBUS message and return it as an octet vector.
Return the AUTHENTICATION-MECHANISM class (or class name) corresponding to NAME.
Associate a AUTHENTICATION-MECHANISM class (or class name) with NAME.
Return the SERVER-ADDRESS class (or class name) corresponding to NAME.
Associate a SERVER-ADDRESS class (or class name) with NAME.
Invokes the GetAll method to retrieve all the properties of an object.
Gets the Machine UUID of the machine hosting the object.
Invokes the Get method to retrieve an object property.
Called when an inexistent entry was sought using DESIGNATOR, and
acts according to the value of IF-DOES-NOT-EXIST:
:ERROR
Signal an INEXISTENT-ENTRY error with a USE-VALUE restart.
NIL
Return NIL.
Returns a list of all currently-owned names on the bus via ListNames method invocation.
Return a fresh vector whose element type is (unsigned-byte 8).
Pack values according to the signature expression and endianness into stream.
Pack DBUS array into stream.
Pack a sequence of values into stream.
Pack DBUS string into stream.
Pack DBUS variant into stream.
Parse a (possibly escaped) server addresses string into a list of server addresses.
Receive authentication response line from the server. If EXPECT is NIL, just return the response command and argument. Otherwise, compare its value to the response command. If they are the same, just return the argument; otherwise, signal an authentication error.
Return true if the new entry should replace the old one. IF-EXISTS
determines how to find out:
:ERROR
Signal an ENTRY-REPLACEMENT-ATTEMPT error with a CONTINUE restart to replace the entry, and an ABORT restart to not replace it.
:WARN
Replace the entry after signaling a warning.
:DONT-REPLACE
Don’t replace entry.
:REPLACE
Replace entry.
Asks DBus to assign a name to the bus. Valid flags
are :allow-replacement, :replace-existing, and :do-not-queue.
Send an authentication command to the server.
Return a list of server addresses for the current session.
Return the signature expression corresponding to the object passed. If the object is a string, it is assumed to be a signature string, otherwise it is assumed to be a signature expression and is returned as-is.
Return the signature string corresponding to the object passed. If the object is a string, it is assumed to be a signature string and is returned as-is, otherwise it is assumed to be a signature expression.
Return the unsigned representation of a signed byte with a given size.
Return the stream’s read position (zero by default).
Set the stream’s read position to a new value.
Return a list of server addresses for the current system.
Unpack values from stream according to endianness and the signature expression and return them as a list.
Unpack DBUS array from stream.
Unpack a sequence of DBUS values from stream.
Unpack DBUS string from stream.
Unpack DBUS variant from stream.
Return the signed representation of an unsigned byte with a given size.
Return true if the value is a sequence with elements of the first type supplied in ELEMENT-TYPES, and false otherwise.
Return true if the message body (which is a list of values) is valid according to the signature expression, and false otherwise.
Return true if the value is a sequence with two elements, both matching the types supplied in ELEMENT-TYPES, and false otherwise.
Return true if the value is a valid signature string or signature expression, and false otherwise.
Return true if the value is a sequence with elements matching the types supplied in ELEMENT-TYPES, and false otherwise.
Return true if the value is a variant value specification, and false otherwise.
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Attempt to authenticate with the server associated
with the connection, and return true if successful. The default value
for IF-FAILED is :ERROR.
Return the name for the authentication mechanism.
automatically generated reader method
name.
Return true if data from server should be converted
to a string, and false if it should remain an octet vector.
automatically generated reader method
Close an open connection.
automatically generated reader method
Return the file descriptor associated with the (open) connection.
Return a 32-bit integer for associating request messages and their replies.
Return a list of the currently pending messages associated with the connection, from newest to oldest.
automatically generated reader method
Set the list of currently pending messages associated with the connection.
automatically generated writer method
Return the address of the server associated with the connection.
automatically generated reader method
Return the unique ID of the server associated with the connection.
automatically generated reader method
uuid.
Set the unique ID of the server associated with the
connection. If an ID is already set and is not EQUAL to the new ID,
signal a continuable error.
uuid.
automatically generated writer method
Return a list of the currently pending messages
associated with the connection, from oldest to newest, and consider
these messages no longer pending.
new.
old.
Feed authentication mechanism with a challenge,
which is either a string or an octet vector in accordance with the
mechanism’s textuality, or :INITIAL-RESPONSE. The method should
return one of the following:
:CONTINUE <response>
Continue with the authentication conversation and send <response>
to the server.
:OK <response>
After sending <response> to the server the client is finished and
expecting an :OK response.
:ERROR
The challenge was invalid.
automatically generated reader method
body.
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
path.
automatically generated reader method
path.
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
Open a connection to the server designated by the
server address and return a connection object. The default value for
IF-FAILED is :ERROR. An IOLIB event base object must be passed.
Should also send the initial "nul byte".
Read a line of text from the server and return it as
a string. The operation blocks until a whole line can be read. The
string will not contain newline characters.
Read a D-BUS message from the server. If no message is available to read, return NIL.
Send a line of text, represented by a string, to
the server. The operation will force (but not finish) output before
returning. The string should not contain any newline characters.
Send an encoded message to the server. The
operation will force (but not finish) output before returning.
Return the value of the server address’s property with the supplied name.
Return the transport name for the server address.
automatically generated reader method
Return a list of authentication mechanisms supported by the server.
Return true if Unix file descriptors can be passed over the connection, and false otherwise.
automatically generated reader method
automatically generated writer method
Wait for a reply message with the supplied serial to be received via connection.
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
The supertype for errors related to the DBUS system.
error.
error.
:designator
This slot is read-only.
:arguments
This slot is read-only.
Previous: Conditions, Up: Public Interface [Contents][Index]
Represents a way to authenticate a client with a server.
:connection
This slot is read-only.
Represents a DBUS connection to a server.
Authenticate using a local cookie and SHA1.
Initarg | Value |
---|---|
:textual | t |
Authenticate using external SASL method.
Initarg | Value |
---|---|
:textual | t |
Represents an authentication mechanism that is not supported by the D-BUS system.
Represents a server address whose transport is not supported by the DBUS system.
:path
This slot is read-only.
:interface
This slot is read-only.
common-lisp.
:member
This slot is read-only.
:reply-serial
This slot is read-only.
Represents a DBUS server address, consisting of a transport name and zero or more properties.
:path
This slot is read-only.
:interface
This slot is read-only.
common-lisp.
:member
This slot is read-only.
:socket
This slot is read-only.
Represents a standard authentication mechanism.
Represents a standard DBUS connection.
Initarg | Value |
---|---|
:uuid | nil |
:server-address
This slot is read-only.
:uuid
(quote nil)
:event-base
This slot is read-only.
1
:endianness
This slot is read-only.
:flags
This slot is read-only.
:major-protocol-version
This slot is read-only.
:body-length
This slot is read-only.
:serial
This slot is read-only.
:destination
This slot is read-only.
:sender
This slot is read-only.
:signature
This slot is read-only.
:body
This slot is read-only.
Represents a standard server address with a transport name and a table of properties.
Represents a connection to a DBUS server over Unix Domain Sockets.
Represents a DBUS server address with Unix Domain Sockets for transport.
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
Map names to AUTHENTICATION-MECHANISM classes or class names.
The directory holding context files containing cookies.
Map names to SERVER-ADDRESS classes or class names.
A mapping from a stream (weakly referenced) to a read position.
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
Return the number of octets to which elements of the supplied type should be aligned.
Call FUNCTION in a context according to IF-FAILED:
:ERROR
Signal an error on failure.
NIL
Return NIL on failure.
Find the cookie corresponding to COOKIE-ID in the appropriate context file.
Format and return authentication command line. Command is one of :AUTH, :CANCEL, :BEGIN, :DATA, :NEGOTIATE-UNIX-FD, or :ERROR, and takes arguments in accordance with the D-BUS specification.
Format a signature expression as a signature string into a character stream.
Pack a single DBUS value into stream.
Parse authentication response line and return two values:
:REJECTED
Current authentication exchanged failed; the second value is a
list of authentication mechanisms.
:OK
Client has been authenticated; the second value is the server’s
UUID.
:DATA
Data are available; the second value is either an octet vector or
a string, depending on the value of AS-STRING.
:AGREE-UNIX-FD
The server supports Unix file descriptor passing; the second value
is NIL.
:ERROR
Bad command or arguments; the second value is NIL.
:UNEXPECTED
Unexpected command; the second value is the response line.
Parse unescaped server addresses text from a character stream and return a list of server addresses.
Parse a signature string from a character stream and return the
corresponding signature expression.
The value of TERMINATOR-CHAR determines when to stop parsing. If it is NIL (the default), parsing is stopped when there are no more characters left to read from the stream. If it is a character, parsing is stopped when the same character is read from the stream.
The value of NUM-ELEMENTS determines how many elements (types) should be read before parsing is stopped. If it is NIL (the default), there is no bound on the number of elements to be read.
Interactively prompt for a value. An expression is read and evaluated, and its value is returned.
Return a string containing a hex-encoded representation of a number of random octet values.
Return a string that is the capitalized symbol name of LISP-NAME, sans dashes.
Unescape a server addresses string per the DBUS specification’s escaping rules and return the unescaped string. The string returned may be the same as the string supplied if no unescaping is needed.
Unpack a single DBUS value from stream.
Return true if the value is of the supplied DBUS type, and false otherwise.
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
automatically generated reader method
automatically generated reader method
automatically generated reader method
name.
automatically generated reader method
path.
automatically generated writer method
path.
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
Previous: Generic functions, Up: Internals [Contents][Index]
:name
This slot is read-only.
:path
(make-hash-table :test (quote equal))
This slot is read-only.
(make-hash-table :test (quote equal))
This slot is read-only.
:name
This slot is read-only.
:signature
This slot is read-only.
:sigexp-formatter
This slot is read-only.
:signature-parser
This slot is read-only.
:alignment
This slot is read-only.
:packer
This slot is read-only.
:unpacker
This slot is read-only.
:checker
This slot is read-only.
:object-name
This slot is read-only.
:lisp-name
This slot is read-only.
:name
This slot is read-only.
:interface
This slot is read-only.
:input-signature
This slot is read-only.
common-lisp.
:function
This slot is read-only.
:name
This slot is read-only.
(make-hash-table :test (quote equal))
This slot is read-only.
(make-hash-table :test (quote equal))
This slot is read-only.
(make-hash-table :test (quote equal))
This slot is read-only.
:name
This slot is read-only.
:signature
This slot is read-only.
:args
This slot is read-only.
:arg-types
This slot is read-only.
:res
This slot is read-only.
:output-signature
This slot is read-only.
:connection
This slot is read-only.
:path
This slot is read-only.
:destination
This slot is read-only.
(make-hash-table :test (quote equal))
This slot is read-only.
Previous: Definitions, Up: The dbus Reference Manual [Contents][Index]
Jump to: | (
A B C D E F G H I L M O P R S U V W |
---|
Jump to: | (
A B C D E F G H I L M O P R S U V W |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
A B C D E F I L M N O P R S T U |
---|
Jump to: | *
A B C D E F I L M N O P R S T U |
---|
Jump to: | A B C D E F G H I M O P S U |
---|
Jump to: | A B C D E F G H I M O P S U |
---|