java.lang.Object
org.freedesktop.dbus.connections.base.AbstractConnectionBase
org.freedesktop.dbus.connections.base.ConnectionMethodInvocation
org.freedesktop.dbus.connections.base.DBusBoundPropertyHandler
org.freedesktop.dbus.connections.base.ConnectionMessageHandler
org.freedesktop.dbus.connections.AbstractConnection
- Alle implementierten Schnittstellen:
Closeable
,AutoCloseable
- Bekannte direkte Unterklassen:
DBusConnection
,DirectConnection
Handles a connection to DBus.
-
Feldübersicht
Modifizierer und TypFeldBeschreibungstatic final Pattern
static final boolean
static final int
static final int
-
Konstruktorübersicht
ModifiziererKonstruktorBeschreibungprotected
AbstractConnection
(TransportConfig _transportConfig, ReceivingServiceConfig _rsCfg) -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoid
addFallback
(String _objectPrefix, DBusInterface _object) Export an object as a fallback object.protected abstract AutoCloseable
addGenericSigHandler
(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) Adds aDBusMatchRule
to with a generic signal handler.<T extends DBusSignal>
AutoCloseableaddSigHandler
(Class<T> _type, DBusInterface _object, DBusSigHandler<T> _handler) Add a Signal Handler.<T extends DBusSignal>
AutoCloseableaddSigHandler
(Class<T> _type, DBusSigHandler<T> _handler) Add a Signal Handler.protected abstract <T extends DBusSignal>
AutoCloseableaddSigHandler
(DBusMatchRule _rule, DBusSigHandler<T> _handler) Add a signal handler with the givenDBusMatchRule
to DBus.protected <T extends DBusSignal>
voidaddSigHandlerWithoutMatch
(Class<? extends DBusSignal> _signal, DBusSigHandler<T> _handler) callMethodAsync
(DBusInterface _object, String _method, Object... _parameters) Call a method asynchronously and get a handle with which to get the reply.<A> void
callWithCallback
(DBusInterface _object, String _m, CallbackHandler<A> _callback, Object... _parameters) Call a method asynchronously and set a callback.protected IncomingMessageThread
createReaderThread
(BusAddress _busAddress) Create the read thread for reading incoming messages.void
exportObject
(String _objectPath, DBusInterface _object) Export an object so that its methods can be called on DBus.void
exportObject
(DBusInterface _object) Export an object so that its methods can be called on DBus.protected <T extends DBusInterface>
List<Class<?>> findMatchingTypes
(Class<T> _type, List<String> _ifaces) If given type is null, will try to find suitable types by examining the given ifaces.boolean
void
queueCallback
(MethodCall _call, Method _method, CallbackHandler<?> _callback) void
removeFallback
(String _objectprefix) Remove a fallbackprotected abstract void
removeGenericSigHandler
(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) Remove a generic signal handler with the givenDBusMatchRule
.<T extends DBusSignal>
voidremoveSigHandler
(Class<T> _type, DBusInterface _object, DBusSigHandler<T> _handler) Remove a Signal Handler.<T extends DBusSignal>
voidremoveSigHandler
(Class<T> _type, DBusSigHandler<T> _handler) Remove a Signal Handler.protected abstract <T extends DBusSignal>
voidremoveSigHandler
(DBusMatchRule _rule, DBusSigHandler<T> _handler) Remove a match rule with the givenDBusSigHandler
.void
setWeakReferences
(boolean _weakreferences) If set to true the bus will not hold a strong reference to exported objects.Von Klasse geerbte Methoden org.freedesktop.dbus.connections.base.ConnectionMessageHandler
handleException, handleMessage, handleMessage
Von Klasse geerbte Methoden org.freedesktop.dbus.connections.base.DBusBoundPropertyHandler
handleDBusBoundProperties, handleGet, handleGetAll, handleSet
Von Klasse geerbte Methoden org.freedesktop.dbus.connections.base.ConnectionMethodInvocation
invokedMethodReply, invokeMethod, invokeMethodAndReply, queueInvokeMethod, setupAndInvoke
Von Klasse geerbte Methoden org.freedesktop.dbus.connections.base.AbstractConnectionBase
close, connect, disconnect, disconnect, getAddress, getBusAddress, getCallbackManager, getCallInfo, getDisconnectCallback, getError, getExportedObject, getExportedObject, getExportedObject, getExportedObjects, getFallbackContainer, getGenericHandledSignals, getHandledSignals, getImportedObjects, getInfoMap, getLogger, getMachineId, getMessageFactory, getObjectTree, getPendingCalls, getPendingErrorQueue, getReceivingService, getTransport, getTransportConfig, internalDisconnect, isConnected, listen, rejectUnknownProperty, sendMessage, setDisconnectCallback, toString, unExportObject
-
Felddetails
-
FLOAT_SUPPORT
public static final boolean FLOAT_SUPPORT -
DOLLAR_PATTERN
-
MAX_ARRAY_LENGTH
public static final int MAX_ARRAY_LENGTH- Siehe auch:
-
MAX_NAME_LENGTH
public static final int MAX_NAME_LENGTH- Siehe auch:
-
-
Konstruktordetails
-
AbstractConnection
protected AbstractConnection(TransportConfig _transportConfig, ReceivingServiceConfig _rsCfg) throws DBusException - Löst aus:
DBusException
-
-
Methodendetails
-
createReaderThread
Beschreibung aus Klasse kopiert:AbstractConnectionBase
Create the read thread for reading incoming messages.- Angegeben von:
createReaderThread
in KlasseAbstractConnectionBase
- Parameter:
_busAddress
- current bus address- Gibt zurück:
- IncomingMessageThread, never
null
-
removeSigHandler
protected abstract <T extends DBusSignal> void removeSigHandler(DBusMatchRule _rule, DBusSigHandler<T> _handler) throws DBusException Remove a match rule with the givenDBusSigHandler
. The rule will only be removed from DBus if no other additional handlers are registered to the same rule.- Typparameter:
T
- signal type- Parameter:
_rule
- rule to remove_handler
- handler to remove- Löst aus:
DBusException
- on error
-
addSigHandler
protected abstract <T extends DBusSignal> AutoCloseable addSigHandler(DBusMatchRule _rule, DBusSigHandler<T> _handler) throws DBusException Add a signal handler with the givenDBusMatchRule
to DBus. The rule will be added to DBus if it was not added before. If the rule was already added, the signal handler is added to the internal map receiving the same signal as the first (and additional) handlers for this rule.- Typparameter:
T
- signal type- Parameter:
_rule
- rule to add_handler
- handler to use- Gibt zurück:
- closeable that removes signal handler
- Löst aus:
DBusException
- on error
-
removeGenericSigHandler
protected abstract void removeGenericSigHandler(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) throws DBusException Remove a generic signal handler with the givenDBusMatchRule
. The rule will only be removed from DBus if no other additional handlers are registered to the same rule.- Parameter:
_rule
- rule to remove_handler
- handler to remove- Löst aus:
DBusException
- on error
-
addGenericSigHandler
protected abstract AutoCloseable addGenericSigHandler(DBusMatchRule _rule, DBusSigHandler<DBusSignal> _handler) throws DBusException Adds aDBusMatchRule
to with a generic signal handler. Generic signal handlers allow receiving different signals with the same handler. If the rule was already added, the signal handler is added to the internal map receiving the same signal as the first (and additional) handlers for this rule.- Parameter:
_rule
- rule to add_handler
- handler to use- Gibt zurück:
- closeable that removes signal handler
- Löst aus:
DBusException
- on error
-
findMatchingTypes
protected <T extends DBusInterface> List<Class<?>> findMatchingTypes(Class<T> _type, List<String> _ifaces) If given type is null, will try to find suitable types by examining the given ifaces. If a non-null type is given, returns the given type.- Typparameter:
T
- any DBusInterface compatible object- Parameter:
_type
- type or null_ifaces
- interfaces to examining when type is null- Gibt zurück:
- List
-
setWeakReferences
public void setWeakReferences(boolean _weakreferences) If set to true the bus will not hold a strong reference to exported objects. If they go out of scope they will automatically be unexported from the bus. The default is to hold a strong reference, which means objects must be explicitly unexported before they will be garbage collected.- Parameter:
_weakreferences
- reference
-
exportObject
Export an object so that its methods can be called on DBus.- Parameter:
_objectPath
- The path to the object we are exposing. MUST be in slash-notation, like "/org/freedesktop/Local", and SHOULD end with a capitalised term. Only one object may be exposed on each path at any one time, but an object may be exposed on several paths at once._object
- The object to export.- Löst aus:
DBusException
- If the objectpath is already exporting an object. or if objectpath is incorrectly formatted,
-
exportObject
Export an object so that its methods can be called on DBus. The path to the object will be taken from theDBusInterface.getObjectPath()
method, make sure it is implemented and returns immutable value. If you want export object with multiple paths, please useexportObject(String, DBusInterface)
.- Parameter:
_object
- The object to export.- Löst aus:
DBusException
- If the object path is already exporting an object or if object path is incorrectly formatted.
-
addFallback
Export an object as a fallback object. This object will have it's methods invoked for all paths starting with this object path.- Parameter:
_objectPrefix
- The path below which the fallback handles calls. MUST be in slash-notation, like "/org/freedesktop/Local",_object
- The object to export.- Löst aus:
DBusException
- If the objectpath is incorrectly formatted,
-
removeFallback
Remove a fallback- Parameter:
_objectprefix
- The prefix to remove the fallback for.
-
removeSigHandler
public <T extends DBusSignal> void removeSigHandler(Class<T> _type, DBusSigHandler<T> _handler) throws DBusException Remove a Signal Handler. Stops listening for this signal.- Typparameter:
T
- class extendingDBusSignal
- Parameter:
_type
- The signal to watch for._handler
- the handler- Löst aus:
DBusException
- If listening for the signal on the bus failed.ClassCastException
- If type is not a sub-type of DBusSignal.
-
removeSigHandler
public <T extends DBusSignal> void removeSigHandler(Class<T> _type, DBusInterface _object, DBusSigHandler<T> _handler) throws DBusException Remove a Signal Handler. Stops listening for this signal.- Typparameter:
T
- class extendingDBusSignal
- Parameter:
_type
- The signal to watch for._object
- The object emitting the signal._handler
- the handler- Löst aus:
DBusException
- If listening for the signal on the bus failed.ClassCastException
- If type is not a sub-type of DBusSignal.
-
addSigHandler
public <T extends DBusSignal> AutoCloseable addSigHandler(Class<T> _type, DBusSigHandler<T> _handler) throws DBusException Add a Signal Handler. Adds a signal handler to call when a signal is received which matches the specified type and name.- Typparameter:
T
- class extendingDBusSignal
- Parameter:
_type
- The signal to watch for._handler
- The handler to call when a signal is received.- Gibt zurück:
- closeable that removes signal handler
- Löst aus:
DBusException
- If listening for the signal on the bus failed.ClassCastException
- If type is not a sub-type of DBusSignal.
-
addSigHandler
public <T extends DBusSignal> AutoCloseable addSigHandler(Class<T> _type, DBusInterface _object, DBusSigHandler<T> _handler) throws DBusException Add a Signal Handler. Adds a signal handler to call when a signal is received which matches the specified type, name and object.- Typparameter:
T
- class extendingDBusSignal
- Parameter:
_type
- The signal to watch for._object
- The object from which the signal will be emitted_handler
- The handler to call when a signal is received.- Gibt zurück:
- closeable that removes signal handler
- Löst aus:
DBusException
- If listening for the signal on the bus failed.ClassCastException
- If type is not a sub-type of DBusSignal.
-
addSigHandlerWithoutMatch
protected <T extends DBusSignal> void addSigHandlerWithoutMatch(Class<? extends DBusSignal> _signal, DBusSigHandler<T> _handler) throws DBusException - Löst aus:
DBusException
-
callWithCallback
public <A> void callWithCallback(DBusInterface _object, String _m, CallbackHandler<A> _callback, Object... _parameters) Call a method asynchronously and set a callback. This handler will be called in a separate thread.- Typparameter:
A
- whatever- Parameter:
_object
- The remote object on which to call the method._m
- The name of the method on the interface to call._callback
- The callback handler._parameters
- The parameters to call the method with.
-
callMethodAsync
public DBusAsyncReply<?> callMethodAsync(DBusInterface _object, String _method, Object... _parameters) Call a method asynchronously and get a handle with which to get the reply.- Parameter:
_object
- The remote object on which to call the method._method
- The name of the method on the interface to call._parameters
- The parameters to call the method with.- Gibt zurück:
- A handle to the call.
-
queueCallback
-
isFileDescriptorSupported
public boolean isFileDescriptorSupported()
-