Class DirectConnection
- java.lang.Object
-
- org.freedesktop.dbus.connections.AbstractConnection
-
- org.freedesktop.dbus.connections.impl.DirectConnection
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public class DirectConnection extends AbstractConnection
Handles a peer to peer connection between two applications withou a bus daemon.Signal Handlers and method calls from remote objects are run in their own threads, you MUST handle the concurrency issues.
-
-
Field Summary
-
Fields inherited from class org.freedesktop.dbus.connections.AbstractConnection
BUSNAME_REGEX, CONNID_REGEX, DOLLAR_PATTERN, FLOAT_SUPPORT, MAX_ARRAY_LENGTH, MAX_NAME_LENGTH, OBJECT_REGEX_PATTERN, TCP_CONNECT_TIMEOUT
-
-
Constructor Summary
Constructors Constructor Description DirectConnection(String address)Create a direct connection to another application.DirectConnection(String address, int timeout)Create a direct connection to another application.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddGenericSigHandler(DBusMatchRule rule, DBusSigHandler<DBusSignal> handler)Adds aDBusMatchRuleto with a generic signal handler.protected <T extends DBusSignal>
voidaddSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler)Add a signal handler with the givenDBusMatchRuleto DBus.static StringcreateDynamicSession()Creates a bus address for a randomly generated abstract unix socket.static StringcreateDynamicTCPSession()Creates a bus address for a randomly generated tcp port.DBusInterfacegetExportedObject(String source, String path)StringgetMachineId()The generated UUID of this machine.DBusInterfacegetRemoteObject(String objectpath)Return a reference to a remote object.<T extends DBusInterface>
TgetRemoteObject(String objectpath, Class<T> type)Return a reference to a remote object.voidlisten()Use this method when running on server side.protected voidremoveGenericSigHandler(DBusMatchRule rule, DBusSigHandler<DBusSignal> handler)Remove a generic signal handler with the givenDBusMatchRule.protected <T extends DBusSignal>
voidremoveSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler)Remove a match rule with the givenDBusSigHandler.-
Methods inherited from class org.freedesktop.dbus.connections.AbstractConnection
addFallback, addSigHandler, addSigHandler, addSigHandlerWithoutMatch, callMethodAsync, callWithCallback, changeThreadCount, close, disconnect, disconnect, exportObject, getAddress, getCallInfo, getEndianness, getError, getExportedObject, getExportedObjects, getGenericHandledSignals, getHandledSignals, getImportedObjects, getObjectTree, getPendingCalls, getPendingErrorQueue, getSystemEndianness, handleException, isConnected, queueCallback, removeFallback, removeSigHandler, removeSigHandler, sendMessage, setEndianness, setWeakReferences, unExportObject
-
-
-
-
Constructor Detail
-
DirectConnection
public DirectConnection(String address) throws DBusException
Create a direct connection to another application.- Parameters:
address- The address to connect to. This is a standard D-Bus address, except that the additional parameter 'listen=true' should be added in the application which is creating the socket.- Throws:
DBusException- on error
-
DirectConnection
public DirectConnection(String address, int timeout) throws DBusException
Create a direct connection to another application.- Parameters:
address- The address to connect to. This is a standard D-Bus address, except that the additional parameter 'listen=true' should be added in the application which is creating the socket.timeout- the timeout set for the underlying socket. 0 will block forever on the underlying socket.- Throws:
DBusException- on error
-
-
Method Detail
-
listen
public void listen()
Use this method when running on server side. Call will block.- Overrides:
listenin classAbstractConnection
-
createDynamicTCPSession
public static String createDynamicTCPSession()
Creates a bus address for a randomly generated tcp port.- Returns:
- a random bus address.
-
createDynamicSession
public static String createDynamicSession()
Creates a bus address for a randomly generated abstract unix socket.- Returns:
- a random bus address.
-
getRemoteObject
public DBusInterface getRemoteObject(String objectpath) throws DBusException
Return a reference to a remote object. This method will always refer to the well known name (if given) rather than resolving it to a unique bus name. In particular this means that if a process providing the well known name disappears and is taken over by another process proxy objects gained by this method will make calls on the new proccess. This method will use bus introspection to determine the interfaces on a remote object and so may block and may fail. The resulting proxy object will, however, be castable to any interface it implements. It will also autostart the process if applicable. Also note that the resulting proxy may fail to execute the correct method with overloaded methods and that complex types may fail in interesting ways. Basically, if something odd happens, try specifying the interface explicitly.- Parameters:
objectpath- The path on which the process is exporting the object.- Returns:
- A reference to a remote object.
- Throws:
ClassCastException- If type is not a sub-type of DBusInterfaceDBusException- If busname or objectpath are incorrectly formatted.
-
getRemoteObject
public <T extends DBusInterface> T getRemoteObject(String objectpath, Class<T> type) throws DBusException
Return a reference to a remote object. This method will always refer to the well known name (if given) rather than resolving it to a unique bus name. In particular this means that if a process providing the well known name disappears and is taken over by another process proxy objects gained by this method will make calls on the new proccess.- Type Parameters:
T- class which extends DBusInterface- Parameters:
objectpath- The path on which the process is exporting the object.type- The interface they are exporting it on. This type must have the same full class name and exposed method signatures as the interface the remote object is exporting.- Returns:
- A reference to a remote object.
- Throws:
ClassCastException- If type is not a sub-type of DBusInterfaceDBusException- If busname or objectpath are incorrectly formatted or type is not in a package.
-
removeSigHandler
protected <T extends DBusSignal> void removeSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler) throws DBusException
Description copied from class:AbstractConnectionRemove 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.- Specified by:
removeSigHandlerin classAbstractConnection- Parameters:
rule- rule to removehandler- handler to remove- Throws:
DBusException- on error
-
addSigHandler
protected <T extends DBusSignal> void addSigHandler(DBusMatchRule rule, DBusSigHandler<T> handler) throws DBusException
Description copied from class:AbstractConnectionAdd a signal handler with the givenDBusMatchRuleto 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.- Specified by:
addSigHandlerin classAbstractConnection- Parameters:
rule- rule to addhandler- handler to use- Throws:
DBusException- on error
-
removeGenericSigHandler
protected void removeGenericSigHandler(DBusMatchRule rule, DBusSigHandler<DBusSignal> handler) throws DBusException
Description copied from class:AbstractConnectionRemove 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.- Specified by:
removeGenericSigHandlerin classAbstractConnection- Parameters:
rule- rule to removehandler- handler to remove- Throws:
DBusException- on error
-
addGenericSigHandler
protected void addGenericSigHandler(DBusMatchRule rule, DBusSigHandler<DBusSignal> handler) throws DBusException
Description copied from class:AbstractConnectionAdds aDBusMatchRuleto 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.- Specified by:
addGenericSigHandlerin classAbstractConnection- Parameters:
rule- rule to addhandler- handler to use- Throws:
DBusException- on error
-
getExportedObject
public DBusInterface getExportedObject(String source, String path) throws DBusException
- Specified by:
getExportedObjectin classAbstractConnection- Throws:
DBusException
-
getMachineId
public String getMachineId()
Description copied from class:AbstractConnectionThe generated UUID of this machine.- Specified by:
getMachineIdin classAbstractConnection- Returns:
- String
-
-