3.1.1 dbus/dbus.asd

Source

dbus.asd.

Parent Component

dbus (system).

ASDF Systems

• dbus.
• dbus/all.
• dbus/utils.
• dbus/protocols.
• dbus/conditions.
• dbus/types.
• dbus/type-definitions.
• dbus/messages.
• dbus/server-addresses.
• dbus/authentication-mechanisms.
• dbus/connections.
• dbus/introspect.
• dbus/convenience.
• dbus/publish.
• dbus/transport-unix.
• dbus/auth-dbus-cookie-sha1.
• dbus/auth-dbus-external.

---

3.1.2 dbus/all/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/all (system).

Packages

dbus/all.

---

3.1.3 dbus/utils/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/utils (system).

Packages

dbus/utils.

Public Interface

• current-username (function).
• decode-hex-string (function).
• define-name-class-mapping (macro).
• encode-hex-string (function).
• entry-replacement-attempt (condition).
• entry-replacement-attempt-new (reader method).
• entry-replacement-attempt-old (reader method).
• inexistent-entry (function).
• inexistent-entry (condition).
• inexistent-entry-designator (reader method).
• make-octet-vector (function).
• replace-entry-p (function).
• signed-to-unsigned (function).
• stream-read-position (function).
• (setf stream-read-position) (function).
• unsigned-to-signed (function).
• with-binary-readers (macro).
• with-binary-writers (macro).
• with-if-failed-handler (macro).

Internals

• *stream-read-positions* (special variable).
• call-with-if-failed-handler (function).
• prompt-for-value (function).

---

3.1.4 dbus/protocols/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/protocols (system).

Packages

dbus/protocols.

Public Interface

• authenticate (generic function).
• authentication-mechanism (class).
• authentication-mechanism-name (generic reader).
• authentication-mechanism-textual-p (generic reader).
• close-connection (generic function).
• connection (class).
• connection-fd (generic function).
• connection-next-serial (generic function).
• connection-pending-messages (generic reader).
• (setf connection-pending-messages) (generic writer).
• connection-server-address (generic reader).
• connection-server-uuid (generic reader).
• (setf connection-server-uuid) (generic function).
• drain-pending-messages (generic function).
• feed-authentication-mechanism (generic function).
• open-connection (generic function).
• receive-line (generic function).
• receive-message-no-hang (generic function).
• send-line (generic function).
• send-message (generic function).
• server-address (class).
• server-address-property (generic function).
• server-address-transport-name (generic reader).
• supported-authentication-mechanisms (generic function).
• supports-unix-fd-passing-p (generic reader).
• wait-for-reply (generic function).

---

3.1.5 dbus/conditions/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/conditions (system).

Packages

dbus/conditions.

Public Interface

• authentication-error (condition).
• authentication-error-argument (reader method).
• authentication-error-command (reader method).
• dbus-error (condition).
• method-error (condition).
• method-error-arguments (reader method).

---

3.1.6 dbus/types/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/types (system).

Packages

dbus/types.

Public Interface

• define-dbus-type (macro).
• pack (function).
• pack-array (function).
• pack-seq (function).
• pack-string (function).
• pack-variant (function).
• print-object (method).
• sigexp (function).
• signature (function).
• unpack (function).
• unpack-array (function).
• unpack-seq (function).
• unpack-string (function).
• unpack-variant (function).
• valid-array-p (function).
• valid-body-p (function).
• valid-dict-entry-p (function).
• valid-signature-p (function).
• valid-struct-p (function).
• valid-variant-p (function).

Internals

• *dbus-type-table* (special variable).
• alignment (function).
• dbus-type (class).
• dbus-type-alignment (reader method).
• dbus-type-checker (reader method).
• dbus-type-name (reader method).
• dbus-type-packer (reader method).
• dbus-type-sigexp-formatter (reader method).
• dbus-type-signature (reader method).
• dbus-type-signature-parser (reader method).
• dbus-type-table (class).
• dbus-type-table-by-name (reader method).
• dbus-type-table-by-signature (reader method).
• dbus-type-unpacker (reader method).
• find-dbus-type (function).
• format-sigexp-to-stream (function).
• make-dbus-type-formatter/parser (function).
• pack-1 (function).
• parse-signature-from-stream (function).
• register-dbus-type (function).
• unpack-1 (function).
• valid-value-p (function).

---

3.1.7 dbus/type-definitions/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/type-definitions (system).

Packages

dbus/type-definitions.

---

3.1.8 dbus/messages/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/messages (system).

Packages

dbus/messages.

Public Interface

• decode-message (function).
• encode-message (function).
• error-message (class).
• invoke-method (function).
• message (class).
• message-body (reader method).
• message-body-length (reader method).
• message-destination (reader method).
• message-endianness (reader method).
• message-error-name (reader method).
• message-flags (reader method).
• message-interface (reader method).
• message-interface (reader method).
• message-major-protocol-version (reader method).
• message-member (reader method).
• message-member (reader method).
• message-no-auto-start (constant).
• message-no-reply-expected (constant).
• message-path (reader method).
• message-path (reader method).
• message-reply-serial (reader method).
• message-reply-serial (reader method).
• message-sender (reader method).
• message-serial (reader method).
• message-signature (reader method).
• method-call-message (class).
• method-return-message (class).
• signal-message (class).
• standard-message (class).

---

3.1.9 dbus/server-addresses/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/server-addresses (system).

Packages

dbus/server-addresses.

Public Interface

• find-server-address-class (function).
• (setf find-server-address-class) (function).
• generic-server-address (class).
• open-connection (method).
• open-connection (method).
• open-connection (method).
• parse-server-addresses-string (function).
• server-address-property (method).
• server-address-transport-name (reader method).
• session-server-addresses (function).
• standard-server-address (class).
• system-server-addresses (function).

Internals

• *server-address-classes* (special variable).
• parse-server-addresses-from-stream (function).
• server-address-properties (reader method).
• unescape-server-addresses-string (function).

---

3.1.10 dbus/authentication-mechanisms/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/authentication-mechanisms (system).

Packages

dbus/authentication-mechanisms.

Public Interface

• authentication-mechanism-name (reader method).
• authentication-mechanism-textual-p (reader method).
• feed-authentication-mechanism (method).
• find-authentication-mechanism-class (function).
• (setf find-authentication-mechanism-class) (function).
• generic-authentication-mechanism (class).
• receive-authentication-response (function).
• send-authentication-command (function).
• standard-authentication-mechanism (class).

Internals

• *authentication-mechanism-classes* (special variable).
• format-authentication-command (function).
• parse-authentication-response (function).

---

3.1.11 dbus/connections/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/connections (system).

Packages

dbus/connections.

Public Interface

• authenticate (method).
• authenticate (method).
• close-connection (method).
• connection-event-base (reader method).
• connection-fd (method).
• connection-next-serial (method).
• connection-pending-messages (reader method).
• (setf connection-pending-messages) (writer method).
• connection-server-address (reader method).
• connection-server-uuid (reader method).
• (setf connection-server-uuid) (writer method).
• (setf connection-server-uuid) (method).
• drain-pending-messages (method).
• open-socket-connection (function).
• receive-line (method).
• receive-message-no-hang (method).
• send-line (method).
• send-message (method).
• socket-connection-mixin (class).
• standard-connection (class).
• supported-authentication-mechanisms (method).
• supports-unix-fd-passing-p (reader method).
• (setf supports-unix-fd-passing-p) (writer method).
• wait-for-reply (method).
• with-open-connection (macro).

Internals

• activate-io-handlers (function).
• connection-socket (reader method).

---

3.1.12 dbus/introspect/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/introspect (system).

Packages

dbus/introspect.

Public Interface

• interface-method (function).
• (setf interface-method) (function).
• interface-name (reader method).
• interface-property (function).
• (setf interface-property) (function).
• interface-signal (function).
• (setf interface-signal) (function).
• list-interface-methods (function).
• list-interface-properties (function).
• list-interface-signals (function).
• list-object-interfaces (function).
• make-object-from-introspection (function).
• method-argument-names (reader method).
• method-argument-types (reader method).
• method-name (reader method).
• method-result-types (reader method).
• method-signature (reader method).
• object-connection (reader method).
• object-destination (reader method).
• object-interface (function).
• (setf object-interface) (function).
• object-invoke (function).
• object-path (reader method).
• parse-introspection-document (function).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• property-access (reader method).
• property-name (reader method).
• property-type (reader method).
• signal-argument-names (reader method).
• signal-argument-types (reader method).
• signal-name (reader method).

Internals

• defaulted-attribute (macro).
• dont-resolve-entities (function).
• fetch-introspection-document (function).
• interface (class).
• interface-methods (reader method).
• interface-properties (reader method).
• interface-signals (reader method).
• make-interface (function).
• make-method (function).
• make-object (function).
• make-property (function).
• make-signal (function).
• method (class).
• object (class).
• object-interfaces (reader method).
• property (class).
• signal (class).
• signature-for-method (function).

---

3.1.13 dbus/convenience/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/convenience (system).

Packages

dbus/convenience.

Public Interface

• add-match (function).
• bus (class).
• bus-connection (reader method).
• bus-name (reader method).
• get-all-properties (function).
• get-machine-id (function).
• get-managed-objects (function).
• get-property (function).
• hello (function).
• list-names (function).
• publish-objects (method).
• request-name (function).
• with-introspected-object (macro).
• with-open-bus (macro).

Internals

call-with-open-bus (function).

---

3.1.14 dbus/publish/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/publish (system).

Packages

dbus/publish.

Public Interface

• *all-dbus-objects* (special variable).
• define-dbus-method (macro).
• define-dbus-object (macro).
• define-dbus-signal-handler (macro).
• publish-objects (generic function).

Internals

• apply-handler (generic function).
• dbus-object (class).
• dbus-object-handler-lookup-table (generic function).
• dbus-object-method-handlers (reader method).
• dbus-object-name (reader method).
• dbus-object-path (reader method).
• (setf dbus-object-path) (writer method).
• dbus-object-signal-handlers (reader method).
• dispatch-message (generic function).
• find-dbus-object (function).
• (setf find-dbus-object) (function).
• full-member-name (function).
• handler (class).
• handler-error (generic function).
• handler-full-lisp-name (generic function).
• handler-function (reader method).
• handler-input-signature (reader method).
• handler-interface (reader method).
• handler-lisp-name (reader method).
• handler-name (reader method).
• handler-object-name (reader method).
• handler-output-signature (reader method).
• lookup-handler (generic function).
• make-object-index (function).
• matching-signatures-p (function).
• method-error-reply (generic function).
• method-handler (class).
• method-handler-bad-results (generic function).
• method-return-reply (generic function).
• missing-handler (generic function).
• register-dbus-method (function).
• register-dbus-object (function).
• register-dbus-signal-handler (function).
• require-dbus-object (function).
• signal-handler (class).
• signature-mismatch (generic function).
• stringify-lisp-name (function).

---

3.1.15 dbus/transport-unix/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/transport-unix (system).

Packages

dbus/transport-unix.

Public Interface

• open-connection (method).
• shared-initialize (method).
• unix-connection (class).
• unix-server-address (class).

Internals

server-address-socket-address (reader method).

---

3.1.16 dbus/auth-dbus-cookie-sha1/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/auth-dbus-cookie-sha1 (system).

Packages

dbus/auth-dbus-cookie-sha1.

Public Interface

• dbus-cookie-sha1-authentication-mechanism (class).
• feed-authentication-mechanism (method).

Internals

• *keyrings-directory* (special variable).
• find-cookie (function).
• random-challenge-string (function).

---

3.1.17 dbus/auth-dbus-external/file-type.lisp

Source

dbus.asd.

Parent Component

dbus/auth-dbus-external (system).

Packages

dbus/auth-dbus-external.

Public Interface

• dbus-external-authentication-mechanism (class).
• feed-authentication-mechanism (method).

---

5.1.1 Constants

Constant: message-no-auto-start ¶

Package

dbus/messages.

Source

file-type.lisp.

Constant: message-no-reply-expected ¶

Package

dbus/messages.

Source

file-type.lisp.

---

5.1.2 Special variables

Special Variable: *all-dbus-objects* ¶

Package

dbus/publish.

Source

file-type.lisp.

---

5.1.3 Macros

Macro: define-dbus-method ((object-name method-name) (&rest parameters) (&rest return-types) &body body) ¶

Package

dbus/publish.

Source

file-type.lisp.

Macro: define-dbus-object (name &body options) ¶

Package

dbus/publish.

Source

file-type.lisp.

Macro: define-dbus-signal-handler ((object-name handler-name) (&rest parameters) &body body) ¶

Package

dbus/publish.

Source

file-type.lisp.

Macro: define-dbus-type (name &key signature composite alignment pack unpack checker) ¶

Package

dbus/types.

Source

file-type.lisp.

Macro: define-name-class-mapping (&key class map find) ¶

Define an interface for mapping names (strings) to classes (or class names).

Package

dbus/utils.

Source

file-type.lisp.

Macro: with-binary-readers ((stream endianness &key prefix) &body forms) ¶

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.

Package

dbus/utils.

Source

file-type.lisp.

Macro: with-binary-writers ((stream endianness &key prefix) &body forms) ¶

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.

Package

dbus/utils.

Source

file-type.lisp.

Macro: with-if-failed-handler (if-failed-form &body forms) ¶

Sugar for CALL-WITH-IF-FAILED-HANDLER.

Package

dbus/utils.

Source

file-type.lisp.

Macro: with-introspected-object ((name bus path destination) &body forms) ¶

Package

dbus/convenience.

Source

file-type.lisp.

Macro: with-open-bus ((bus-var server-addresses &key event-base) &body forms) ¶

Package

dbus/convenience.

Source

file-type.lisp.

Macro: with-open-connection ((connection event-base server-addresses &key if-failed) &body forms) ¶

Package

dbus/connections.

Source

file-type.lisp.

---

5.1.4 Ordinary functions

Function: add-match (bus &rest parameters) ¶

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

Package

dbus/convenience.

Source

file-type.lisp.

Function: current-username () ¶

Return the current user’s name.

Package

dbus/utils.

Source

file-type.lisp.

Function: decode-hex-string (string &key start end) ¶

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.

Package

dbus/utils.

Source

file-type.lisp.

Function: decode-message (stream) ¶

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.

Package

dbus/messages.

Source

file-type.lisp.

Function: encode-hex-string (data &key start end) ¶

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.

Package

dbus/utils.

Source

file-type.lisp.

Function: encode-message (endianness type flags major-protocol-version serial path interface member error-name reply-serial destination sender signature body) ¶

Encode a DBUS message and return it as an octet vector.

Package

dbus/messages.

Source

file-type.lisp.

Function: find-authentication-mechanism-class (name &key if-does-not-exist) ¶

Return the AUTHENTICATION-MECHANISM class (or class name) corresponding to NAME.

Package

dbus/authentication-mechanisms.

Source

file-type.lisp.

Function: (setf find-authentication-mechanism-class) (name &key if-exists) ¶

Associate a AUTHENTICATION-MECHANISM class (or class name) with NAME.

Package

dbus/authentication-mechanisms.

Source

file-type.lisp.

Function: find-server-address-class (name &key if-does-not-exist) ¶

Return the SERVER-ADDRESS class (or class name) corresponding to NAME.

Package

dbus/server-addresses.

Source

file-type.lisp.

Function: (setf find-server-address-class) (name &key if-exists) ¶

Associate a SERVER-ADDRESS class (or class name) with NAME.

Package

dbus/server-addresses.

Source

file-type.lisp.

Function: get-all-properties (bus service object interface) ¶

Invokes the GetAll method to retrieve all the properties of an object.

Package

dbus/convenience.

Source

file-type.lisp.

Function: get-machine-id (bus) ¶

Gets the Machine UUID of the machine hosting the object.

Package

dbus/convenience.

Source

file-type.lisp.

Function: get-managed-objects (bus service object) ¶

Package

dbus/convenience.

Source

file-type.lisp.

Function: get-property (bus service object interface property) ¶

Invokes the Get method to retrieve an object property.

Package

dbus/convenience.

Source

file-type.lisp.

Function: hello (connection) ¶

Package

dbus/convenience.

Source

file-type.lisp.

Function: inexistent-entry (designator if-does-not-exist) ¶

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.

Package

dbus/utils.

Source

file-type.lisp.

Function: interface-method (name interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: (setf interface-method) (name interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: interface-property (name interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: (setf interface-property) (name interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: interface-signal (name interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: (setf interface-signal) (name interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: invoke-method (connection member &key path signature arguments interface destination no-reply no-auto-start asynchronous endianness) ¶

Package

dbus/messages.

Source

file-type.lisp.

Function: list-interface-methods (interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: list-interface-properties (interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: list-interface-signals (interface) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: list-names (bus) ¶

Returns a list of all currently-owned names on the bus via ListNames method invocation.

Package

dbus/convenience.

Source

file-type.lisp.

Function: list-object-interfaces (object) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: make-object-from-introspection (connection path destination) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: make-octet-vector (size &rest array-options) ¶

Return a fresh vector whose element type is (unsigned-byte 8).

Package

dbus/utils.

Source

file-type.lisp.

Function: object-interface (name object) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: (setf object-interface) (name object) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: object-invoke (object interface-name method-name &rest args) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: open-socket-connection (address-family socket-address) ¶

Package

dbus/connections.

Source

file-type.lisp.

Function: pack (stream endianness sigexp &rest values) ¶

Pack values according to the signature expression and endianness into stream.

Package

dbus/types.

Source

file-type.lisp.

Function: pack-array (stream endianness element-type value) ¶

Pack DBUS array into stream.

Package

dbus/types.

Source

file-type.lisp.

Function: pack-seq (stream endianness types values) ¶

Pack a sequence of values into stream.

Package

dbus/types.

Source

file-type.lisp.

Function: pack-string (stream endianness value length-size) ¶

Pack DBUS string into stream.

Package

dbus/types.

Source

file-type.lisp.

Function: pack-variant (stream endianness element-types value) ¶

Pack DBUS variant into stream.

Package

dbus/types.

Source

file-type.lisp.

Function: parse-introspection-document (input) ¶

Package

dbus/introspect.

Source

file-type.lisp.

Function: parse-server-addresses-string (string) ¶

Parse a (possibly escaped) server addresses string into a list of server addresses.

Package

dbus/server-addresses.

Source

file-type.lisp.

Function: receive-authentication-response (connection &key as-string expect) ¶

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.

Package

dbus/authentication-mechanisms.

Source

file-type.lisp.

Function: replace-entry-p (old new if-exists) ¶

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.

Package

dbus/utils.

Source

file-type.lisp.

Function: request-name (bus name &rest flags) ¶

Asks DBus to assign a name to the bus. Valid flags
are :allow-replacement, :replace-existing, and :do-not-queue.

Package

dbus/convenience.

Source

file-type.lisp.

Function: send-authentication-command (connection command &rest arguments) ¶

Send an authentication command to the server.

Package

dbus/authentication-mechanisms.

Source

file-type.lisp.

Function: session-server-addresses () ¶

Return a list of server addresses for the current session.

Package

dbus/server-addresses.

Source

file-type.lisp.

Function: sigexp (object) ¶

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.

Package

dbus/types.

Source

file-type.lisp.

Function: signature (object) ¶

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.

Package

dbus/types.

Source

file-type.lisp.

Function: signed-to-unsigned (value size) ¶

Return the unsigned representation of a signed byte with a given size.

Package

dbus/utils.

Source

file-type.lisp.

Function: stream-read-position (stream) ¶

Return the stream’s read position (zero by default).

Package

dbus/utils.

Source

file-type.lisp.

Function: (setf stream-read-position) (stream) ¶

Set the stream’s read position to a new value.

Package

dbus/utils.

Source

file-type.lisp.

Function: system-server-addresses () ¶

Return a list of server addresses for the current system.

Package

dbus/server-addresses.

Source

file-type.lisp.

Function: unpack (stream endianness sigexp) ¶

Unpack values from stream according to endianness and the signature expression and return them as a list.

Package

dbus/types.

Source

file-type.lisp.

Function: unpack-array (stream endianness element-type length) ¶

Unpack DBUS array from stream.

Package

dbus/types.

Source

file-type.lisp.

Function: unpack-seq (stream endianness types) ¶

Unpack a sequence of DBUS values from stream.

Package

dbus/types.

Source

file-type.lisp.

Function: unpack-string (stream endianness length) ¶

Unpack DBUS string from stream.

Package

dbus/types.

Source

file-type.lisp.

Function: unpack-variant (stream endianness) ¶

Unpack DBUS variant from stream.

Package

dbus/types.

Source

file-type.lisp.

Function: unsigned-to-signed (value size) ¶

Return the signed representation of an unsigned byte with a given size.

Package

dbus/utils.

Source

file-type.lisp.

Function: valid-array-p (value element-types) ¶

Return true if the value is a sequence with elements of the first type supplied in ELEMENT-TYPES, and false otherwise.

Package

dbus/types.

Source

file-type.lisp.

Function: valid-body-p (body sigexp) ¶

Return true if the message body (which is a list of values) is valid according to the signature expression, and false otherwise.

Package

dbus/types.

Source

file-type.lisp.

Function: valid-dict-entry-p (value element-types) ¶

Return true if the value is a sequence with two elements, both matching the types supplied in ELEMENT-TYPES, and false otherwise.

Package

dbus/types.

Source

file-type.lisp.

Function: valid-signature-p (value element-types) ¶

Return true if the value is a valid signature string or signature expression, and false otherwise.

Package

dbus/types.

Source

file-type.lisp.

Function: valid-struct-p (value element-types) ¶

Return true if the value is a sequence with elements matching the types supplied in ELEMENT-TYPES, and false otherwise.

Package

dbus/types.

Source

file-type.lisp.

Function: valid-variant-p (value element-types) ¶

Return true if the value is a variant value specification, and false otherwise.

Package

dbus/types.

Source

file-type.lisp.

---

5.1.5 Generic functions

Generic Function: authenticate (authentication-mechanisms connection &key if-failed) ¶

Attempt to authenticate with the server associated
with the connection, and return true if successful. The default value for IF-FAILED is :ERROR.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: authenticate (mechanisms (connection standard-connection) &key if-failed) ¶

Source

file-type.lisp.

Method: authenticate :around (mechanisms (connection standard-connection) &key if-failed) ¶

Source

file-type.lisp.

Generic Reader: authentication-error-argument (condition) ¶

Package

dbus/conditions.

Methods

Reader Method: authentication-error-argument ((condition authentication-error)) ¶

Source

file-type.lisp.

Target Slot

argument.

Generic Reader: authentication-error-command (condition) ¶

Package

dbus/conditions.

Methods

Reader Method: authentication-error-command ((condition authentication-error)) ¶

Source

file-type.lisp.

Target Slot

command.

Generic Reader: authentication-mechanism-name (authentication-mechanism) ¶

Return the name for the authentication mechanism.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Reader Method: authentication-mechanism-name ((standard-authentication-mechanism standard-authentication-mechanism)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Reader: authentication-mechanism-textual-p (authentication-mechanism) ¶

Return true if data from server should be converted
to a string, and false if it should remain an octet vector.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Reader Method: authentication-mechanism-textual-p ((standard-authentication-mechanism standard-authentication-mechanism)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

textual.

Generic Reader: bus-connection (object) ¶

Package

dbus/convenience.

Methods

Reader Method: bus-connection ((bus bus)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

connection.

Generic Reader: bus-name (object) ¶

Package

dbus/convenience.

Methods

Reader Method: bus-name ((bus bus)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Function: close-connection (connection) ¶

Close an open connection.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: close-connection ((connection socket-connection-mixin)) ¶

Source

file-type.lisp.

Generic Reader: connection-event-base (object) ¶

Package

dbus/connections.

Methods

Reader Method: connection-event-base ((standard-connection standard-connection)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

event-base.

Generic Function: connection-fd (connection) ¶

Return the file descriptor associated with the (open) connection.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: connection-fd ((connection socket-connection-mixin)) ¶

Source

file-type.lisp.

Generic Function: connection-next-serial (connection) ¶

Return a 32-bit integer for associating request messages and their replies.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: connection-next-serial ((connection standard-connection)) ¶

Source

file-type.lisp.

Generic Reader: connection-pending-messages (connection) ¶

Return a list of the currently pending messages associated with the connection, from newest to oldest.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Reader Method: connection-pending-messages ((standard-connection standard-connection)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

pending-messages.

Generic Writer: (setf connection-pending-messages) (connection) ¶

Set the list of currently pending messages associated with the connection.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Writer Method: (setf connection-pending-messages) ((standard-connection standard-connection)) ¶

automatically generated writer method

Source

file-type.lisp.

Target Slot

pending-messages.

Generic Reader: connection-server-address (connection) ¶

Return the address of the server associated with the connection.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Reader Method: connection-server-address ((standard-connection standard-connection)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

server-address.

Generic Reader: connection-server-uuid (connection) ¶

Return the unique ID of the server associated with the connection.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Reader Method: connection-server-uuid ((standard-connection standard-connection)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

uuid.

Generic Function: (setf connection-server-uuid) (connection) ¶

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.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Writer Method: (setf connection-server-uuid) :before ((connection standard-connection)) ¶

Source

file-type.lisp.

Target Slot

uuid.

Method: (setf connection-server-uuid) ((standard-connection standard-connection)) ¶

automatically generated writer method

Source

file-type.lisp.

Generic Function: drain-pending-messages (connection) ¶

Return a list of the currently pending messages
associated with the connection, from oldest to newest, and consider these messages no longer pending.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: drain-pending-messages ((connection standard-connection)) ¶

Source

file-type.lisp.

Generic Reader: entry-replacement-attempt-new (condition) ¶

Package

dbus/utils.

Methods

Reader Method: entry-replacement-attempt-new ((condition entry-replacement-attempt)) ¶

Source

file-type.lisp.

Target Slot

new.

Generic Reader: entry-replacement-attempt-old (condition) ¶

Package

dbus/utils.

Methods

Reader Method: entry-replacement-attempt-old ((condition entry-replacement-attempt)) ¶

Source

file-type.lisp.

Target Slot

old.

Generic Function: feed-authentication-mechanism (authentication-mechanism challenge) ¶

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.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: feed-authentication-mechanism ((mechanism dbus-external-authentication-mechanism) challenge) ¶

Source

file-type.lisp.

Method: feed-authentication-mechanism ((mechanism dbus-cookie-sha1-authentication-mechanism) challenge) ¶

Source

file-type.lisp.

Method: feed-authentication-mechanism ((mechanism generic-authentication-mechanism) challenge) ¶

Source

file-type.lisp.

Generic Reader: inexistent-entry-designator (condition) ¶

Package

dbus/utils.

Methods

Reader Method: inexistent-entry-designator ((condition inexistent-entry)) ¶

Source

file-type.lisp.

Target Slot

designator.

Generic Reader: interface-name (object) ¶

Package

dbus/introspect.

Methods

Reader Method: interface-name ((interface interface)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Reader: message-body (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-body ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

body.

Generic Reader: message-body-length (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-body-length ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

body-length.

Generic Reader: message-destination (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-destination ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

destination.

Generic Reader: message-endianness (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-endianness ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

endianness.

Generic Reader: message-error-name (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-error-name ((error-message error-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

error-name.

Generic Reader: message-flags (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-flags ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

flags.

Generic Reader: message-interface (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-interface ((signal-message signal-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

interface.

Reader Method: message-interface ((method-call-message method-call-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

interface.

Generic Reader: message-major-protocol-version (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-major-protocol-version ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

major-protocol-version.

Generic Reader: message-member (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-member ((signal-message signal-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

member.

Reader Method: message-member ((method-call-message method-call-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

member.

Generic Reader: message-path (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-path ((signal-message signal-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

path.

Reader Method: message-path ((method-call-message method-call-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

path.

Generic Reader: message-reply-serial (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-reply-serial ((error-message error-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

reply-serial.

Reader Method: message-reply-serial ((method-return-message method-return-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

reply-serial.

Generic Reader: message-sender (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-sender ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

sender.

Generic Reader: message-serial (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-serial ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

serial.

Generic Reader: message-signature (object) ¶

Package

dbus/messages.

Methods

Reader Method: message-signature ((standard-message standard-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

signature.

Generic Reader: method-argument-names (object) ¶

Package

dbus/introspect.

Methods

Reader Method: method-argument-names ((method method)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

arg-names.

Generic Reader: method-argument-types (object) ¶

Package

dbus/introspect.

Methods

Reader Method: method-argument-types ((method method)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

arg-types.

Generic Reader: method-error-arguments (condition) ¶

Package

dbus/conditions.

Methods

Reader Method: method-error-arguments ((condition method-error)) ¶

Source

file-type.lisp.

Target Slot

arguments.

Generic Reader: method-name (object) ¶

Package

dbus/introspect.

Methods

Reader Method: method-name ((method method)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Reader: method-result-types (object) ¶

Package

dbus/introspect.

Methods

Reader Method: method-result-types ((method method)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

results.

Generic Reader: method-signature (object) ¶

Package

dbus/introspect.

Methods

Reader Method: method-signature ((method method)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

signature.

Generic Reader: object-connection (object) ¶

Package

dbus/introspect.

Methods

Reader Method: object-connection ((object object)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

connection.

Generic Reader: object-destination (object) ¶

Package

dbus/introspect.

Methods

Reader Method: object-destination ((object object)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

destination.

Generic Reader: object-path (object) ¶

Package

dbus/introspect.

Methods

Reader Method: object-path ((object object)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

path.

Generic Function: open-connection (event-base server-address &key if-failed) ¶

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".

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: open-connection (event-base (address unix-server-address) &key if-failed) ¶

Source

file-type.lisp.

Method: open-connection (event-base (address generic-server-address) &key if-failed) ¶

Source

file-type.lisp.

Method: open-connection (event-base (addresses list) &key if-failed) ¶

Source

file-type.lisp.

Method: open-connection :around (event-base (server-address standard-server-address) &key if-failed) ¶

Source

file-type.lisp.

Generic Reader: property-access (object) ¶

Package

dbus/introspect.

Methods

Reader Method: property-access ((property property)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

access.

Generic Reader: property-name (object) ¶

Package

dbus/introspect.

Methods

Reader Method: property-name ((property property)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Reader: property-type (object) ¶

Package

dbus/introspect.

Methods

Reader Method: property-type ((property property)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

type.

Generic Function: publish-objects (connection &optional object-names) ¶

Package

dbus/publish.

Source

file-type.lisp.

Methods

Method: publish-objects ((bus bus) &optional object-names) ¶

Source

file-type.lisp.

Method: publish-objects ((connection standard-connection) &optional object-names) ¶

Generic Function: receive-line (connection) ¶

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.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: receive-line ((connection socket-connection-mixin)) ¶

Source

file-type.lisp.

Generic Function: receive-message-no-hang (connection) ¶

Read a D-BUS message from the server. If no message is available to read, return NIL.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: receive-message-no-hang ((connection socket-connection-mixin)) ¶

Source

file-type.lisp.

Generic Function: send-line (line connection) ¶

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.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: send-line (line (connection socket-connection-mixin)) ¶

Source

file-type.lisp.

Generic Function: send-message (encoded-message connection) ¶

Send an encoded message to the server. The
operation will force (but not finish) output before returning.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: send-message (encoded-message (connection socket-connection-mixin)) ¶

Source

file-type.lisp.

Generic Function: server-address-property (name server-address &key if-does-not-exist) ¶

Return the value of the server address’s property with the supplied name.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: server-address-property (name (server-address standard-server-address) &key if-does-not-exist) ¶

Source

file-type.lisp.

Generic Reader: server-address-transport-name (server-address) ¶

Return the transport name for the server address.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Reader Method: server-address-transport-name ((standard-server-address standard-server-address)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

transport-name.

Generic Reader: signal-argument-names (object) ¶

Package

dbus/introspect.

Methods

Reader Method: signal-argument-names ((signal signal)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

arg-names.

Generic Reader: signal-argument-types (object) ¶

Package

dbus/introspect.

Methods

Reader Method: signal-argument-types ((signal signal)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

arg-types.

Generic Reader: signal-name (object) ¶

Package

dbus/introspect.

Methods

Reader Method: signal-name ((signal signal)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

name.

Generic Function: supported-authentication-mechanisms (connection) ¶

Return a list of authentication mechanisms supported by the server.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: supported-authentication-mechanisms ((connection standard-connection)) ¶

Source

file-type.lisp.

Generic Reader: supports-unix-fd-passing-p (connection) ¶

Return true if Unix file descriptors can be passed over the connection, and false otherwise.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Reader Method: supports-unix-fd-passing-p ((standard-connection standard-connection)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

supports-unix-fd-passing.

Generic Writer: (setf supports-unix-fd-passing-p) (object) ¶

Package

dbus/protocols.

Methods

Writer Method: (setf supports-unix-fd-passing-p) ((standard-connection standard-connection)) ¶

automatically generated writer method

Source

file-type.lisp.

Target Slot

supports-unix-fd-passing.

Generic Function: wait-for-reply (serial connection) ¶

Wait for a reply message with the supplied serial to be received via connection.

Package

dbus/protocols.

Source

file-type.lisp.

Methods

Method: wait-for-reply (serial (connection standard-connection)) ¶

Source

file-type.lisp.

---