dbus-java 5.1.1 · org.freedesktop.dbus.connections.impl.BaseConnectionBuilder

Modifier and Type	Field and Description
private final ConnectionConfig	connectionConfig
private final Class<R>	returnType
private final ReceivingServiceConfigBuilder<R>	rsConfigBuilder
private final TransportConfigBuilder<?, R>	transportConfigBuilder

Access	Constructor and Description
protected	BaseConnectionBuilder(Class<R> _returnType, BusAddress _address)

Method Summary

Modifier and Type	Method and Description
public abstract C	build()
protected ReceivingServiceConfig	Returns: config buildThreadConfig() Creates the configuration to use for `ReceivingService`.
protected TransportConfig	Returns: config buildTransportConfig() Creates the configuration to use for `TransportBuilder`.
protected ConnectionConfig	Returns: config getConnectionConfig() Returns the currently configured connection configuration.
public static byte	Returns: LITTLE or BIG getSystemEndianness() Get the default system endianness.
public ReceivingServiceConfigBuilder<R>	Returns: builder receivingThreadConfig() Returns the builder to configure the receiving thread pools.
pack-priv R	Returns: concrete version of this self() Return ourselves.
public TransportConfigBuilder<?, R>	Returns: builder transportConfig() Returns the builder to configure the used transport.
public R	Returns: this withDisconnectCallback(IDisconnectCallback callback _disconnectCallback) Set the given disconnect callback to the created connection.
public R	Returns: this withExportWeakReferences(boolean true to enable _weakRef) Enable/Disable usage of weak references for exported objects.
public R	Returns: this withImportWeakReferences(boolean true to enable _weakRef) Enable/Disable usage of weak references for imported objects.
public R	Returns: this withUnknownSignalHandler(Consumer<DBusSignal> callback which receives all unknown signals _handler) Configures a consumer which will receive any signal which could not be handled.
public R	Returns: this withWeakReferences(boolean true to enable _weakRef) Deprecated for removal since 5.1.0 - 2024-07-12. use `withExportWeakReferences(boolean)` instead Enable/Disable weak references on connection.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

connectionConfig	back to summary
private final ConnectionConfig connectionConfig

returnType	back to summary
private final Class<R> returnType

rsConfigBuilder	back to summary
private final ReceivingServiceConfigBuilder<R> rsConfigBuilder

transportConfigBuilder	back to summary
private final TransportConfigBuilder<?, R> transportConfigBuilder

BaseConnectionBuilder	back to summary
protected BaseConnectionBuilder(Class<R> _returnType, BusAddress _address)

Method Detail

build	back to summary
public abstract C build() throws DBusException

buildThreadConfig back to summary

buildThreadConfig	back to summary
protected ReceivingServiceConfig buildThreadConfig() Creates the configuration to use for `ReceivingService`. Returns:ReceivingServiceConfig config

protected ReceivingServiceConfig buildThreadConfig()

Creates the configuration to use for ReceivingService.

Returns:ReceivingServiceConfig: config

buildTransportConfig back to summary

buildTransportConfig	back to summary
protected TransportConfig buildTransportConfig() Creates the configuration to use for `TransportBuilder`. Returns:TransportConfig config

protected TransportConfig buildTransportConfig()

Creates the configuration to use for TransportBuilder.

Returns:TransportConfig: config

getConnectionConfig	back to summary
protected ConnectionConfig getConnectionConfig() Returns the currently configured connection configuration. Returns:ConnectionConfig config

getConnectionConfig

back to summary

protected ConnectionConfig getConnectionConfig()

Returns the currently configured connection configuration.

Returns:ConnectionConfig: config

getSystemEndianness	back to summary
public static byte getSystemEndianness() Get the default system endianness. Returns:byte LITTLE or BIG

getSystemEndianness

back to summary

public static byte getSystemEndianness()

Get the default system endianness.

Returns:byte: LITTLE or BIG

receivingThreadConfig	back to summary
public ReceivingServiceConfigBuilder<R> receivingThreadConfig() Returns the builder to configure the receiving thread pools. Returns:ReceivingServiceConfigBuilder<R> builder

receivingThreadConfig

back to summary

public ReceivingServiceConfigBuilder<R> receivingThreadConfig()

Returns the builder to configure the receiving thread pools.

Returns:ReceivingServiceConfigBuilder<R>: builder

self	back to summary
pack-priv R self() Return ourselves. Returns:R concrete version of this

self

back to summary

pack-priv R self()

Return ourselves.

Returns:R: concrete version of this

transportConfig	back to summary
public TransportConfigBuilder<?, R> transportConfig() Returns the builder to configure the used transport. Returns:TransportConfigBuilder<?, R> builder

transportConfig

back to summary

public TransportConfigBuilder<?, R> transportConfig()

Returns the builder to configure the used transport.

Returns:TransportConfigBuilder<?, R>: builder

withDisconnectCallback	back to summary
public R withDisconnectCallback(IDisconnectCallback _disconnectCallback) Set the given disconnect callback to the created connection. Parameters _disconnectCallback:IDisconnectCallback callback Returns:R this

withDisconnectCallback

back to summary

public R withDisconnectCallback(IDisconnectCallback _disconnectCallback)

Set the given disconnect callback to the created connection.

Parameters

_disconnectCallback:IDisconnectCallback: callback

Returns:R

this

withExportWeakReferences	back to summary
public R withExportWeakReferences(boolean _weakRef) Enable/Disable usage of weak references for exported objects. Exported objects are objects provided by the application to DBus and are used through DBus by other applications. Using weak references may allow the Garbage Collector to remove exported objects when they are no longer reachable. Enabling this feature may cause dbus-java to be forced to re-create exported objects because the GC already cleaned up the old references. Use with caution! Default is false. Parameters _weakRef:boolean true to enable Returns:R this

withExportWeakReferences

back to summary

public R withExportWeakReferences(boolean _weakRef)

Enable/Disable usage of weak references for exported objects.

Exported objects are objects provided by the application to DBus and are used through DBus by other applications.

Using weak references may allow the Garbage Collector to remove exported objects when they are no longer reachable. Enabling this feature may cause dbus-java to be forced to re-create exported objects because the GC already cleaned up the old references.
Use with caution!

Default is false.

Parameters

_weakRef:boolean: true to enable

Returns:R

this

withImportWeakReferences	back to summary
public R withImportWeakReferences(boolean _weakRef) Enable/Disable usage of weak references for imported objects. Imported objects are all objects which are created when calling interfaces which belong to any object provided by DBus. E.g. when you want to use Bluetooth, you will query the bluez interfaces on the bus which will create a proxy object in dbus-java. These objects are stored in an internal Map so re-querying the same object will return the cached object instead of creating a new proxy. Usually all imported objects are dropped when the connection gets closed (by either side). If the application will not close the connection and run for a long time the default behavior may cause high memory usage. Enabling weak references may allow the Garbage Collector to remove imported objects when they are no longer reachable. This will free up memory when no other references are kept on the remote imported object. The current default is false. Anyway it is considered to enable weak references for imported objects as default in the future. Parameters _weakRef:boolean true to enable Returns:R this

withImportWeakReferences

back to summary

public R withImportWeakReferences(boolean _weakRef)

Enable/Disable usage of weak references for imported objects.

Imported objects are all objects which are created when calling interfaces which belong to any object provided by DBus.
E.g. when you want to use Bluetooth, you will query the bluez interfaces on the bus which will create a proxy object in dbus-java.
These objects are stored in an internal Map so re-querying the same object will return the cached object instead of creating a new proxy.

Usually all imported objects are dropped when the connection gets closed (by either side).
If the application will not close the connection and run for a long time the default behavior may cause high memory usage.
Enabling weak references may allow the Garbage Collector to remove imported objects when they are no longer reachable.
This will free up memory when no other references are kept on the remote imported object.

The current default is false.
Anyway it is considered to enable weak references for imported objects as default in the future.

Parameters

_weakRef:boolean: true to enable

Returns:R

this

withUnknownSignalHandler	back to summary
public R withUnknownSignalHandler(Consumer<DBusSignal> _handler) Configures a consumer which will receive any signal which could not be handled. By default, no handler is configured, so unknown/unhandled signals will be ignored and only be logged as warn message. Parameters _handler:Consumer<DBusSignal> callback which receives all unknown signals Returns:R this Since 5.1.1 - 2024-09-11

withUnknownSignalHandler

back to summary

public R withUnknownSignalHandler(Consumer<DBusSignal> _handler)

Configures a consumer which will receive any signal which could not be handled.

By default, no handler is configured, so unknown/unhandled signals will be ignored and only be logged as warn message.

Parameters

_handler:Consumer<DBusSignal>: callback which receives all unknown signals

Returns:R

this

Since

5.1.1 - 2024-09-11

withWeakReferences back to summary

withWeakReferences	back to summary
public R withWeakReferences(boolean _weakRef) Deprecated for removal since 5.1.0 - 2024-07-12. use `withExportWeakReferences(boolean)` instead Enable/Disable weak references on connection. Default is false. Parameters _weakRef:boolean true to enable Returns:R this Annotations @Deprecated forRemoval:true since:5.1.0 - 2024-07-12

public R withWeakReferences(boolean _weakRef)

Deprecated

for removal since 5.1.0 - 2024-07-12.

use withExportWeakReferences(boolean) instead

Enable/Disable weak references on connection. Default is false.

Parameters

_weakRef:boolean: true to enable

Returns:R

this

Annotations

@Deprecated
forRemoval:true
since:5.1.0 - 2024-07-12

public abstract Class BaseConnectionBuilder<R extends BaseConnectionBuilder<R, C>, C extends AbstractConnection>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail