Klasse AbstractConnection

Alle implementierten Schnittstellen:
Closeable, AutoCloseable
Bekannte direkte Unterklassen:
DBusConnection, DirectConnection

public abstract non-sealed class AbstractConnection extends ConnectionMessageHandler
Handles a connection to DBus.
  • Felddetails

    • FLOAT_SUPPORT

      public static final boolean FLOAT_SUPPORT
    • DOLLAR_PATTERN

      public static final Pattern 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

  • Methodendetails

    • createReaderThread

      protected IncomingMessageThread createReaderThread(BusAddress _busAddress)
      Beschreibung aus Klasse kopiert: AbstractConnectionBase
      Create the read thread for reading incoming messages.
      Angegeben von:
      createReaderThread in Klasse AbstractConnectionBase
      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 given DBusSigHandler. 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 given DBusMatchRule 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 given DBusMatchRule. 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 a DBusMatchRule 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

      public void exportObject(String _objectPath, DBusInterface _object) throws DBusException
      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

      public void exportObject(DBusInterface _object) throws DBusException
      Export an object so that its methods can be called on DBus. The path to the object will be taken from the DBusInterface.getObjectPath() method, make sure it is implemented and returns immutable value. If you want export object with multiple paths, please use exportObject(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

      public void addFallback(String _objectPrefix, DBusInterface _object) throws DBusException
      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

      public void removeFallback(String _objectprefix)
      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 extending DBusSignal
      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 extending DBusSignal
      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 extending DBusSignal
      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 extending DBusSignal
      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

      public void queueCallback(MethodCall _call, Method _method, CallbackHandler<?> _callback)
    • isFileDescriptorSupported

      public boolean isFileDescriptorSupported()