Package org.freedesktop.dbus.connections.impl

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

java.lang.Object

org.freedesktop.dbus.connections.impl.BaseConnectionBuilder<R,C>

Type Parameters:

R - concrete type of connection builder

Direct Known Subclasses:

DBusConnectionBuilder, DirectConnectionBuilder

public abstract class BaseConnectionBuilder<R extends BaseConnectionBuilder<R,C>,C extends AbstractConnection>
extends Object

Base class for connection builders containing commonly used options.

Since:

4.2.0 - 2022-07-13

Field Summary

Fields

Modifier and Type	Field	Description
private IDisconnectCallback	disconnectCallback
private byte	endianess
private final Class<R>	returnType
private final ReceivingServiceConfigBuilder<R>	rsConfigBuilder
private final TransportConfigBuilder<?,R>	transportConfigBuilder
private boolean	weakReference

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract C	build()
protected ReceivingServiceConfig	buildThreadConfig()	Creates the configuration to use for ReceivingService.
protected TransportConfig	buildTransportConfig()	Creates the configuration to use for TransportBuilder.
protected IDisconnectCallback	getDisconnectCallback()
protected byte	getEndianess()
static byte	getSystemEndianness()	Get the default system endianness.
protected boolean	isWeakReference()
ReceivingServiceConfigBuilder<R>	receivingThreadConfig()	Returns the builder to configure the receiving thread pools.
(package private) R	self()	Return ourselves.
TransportConfigBuilder<?,R>	transportConfig()	Returns the builder to configure the used transport.
R	withDisconnectCallback(IDisconnectCallback _disconnectCallback)	Set the given disconnect callback to the created connection.
R	withEndianess(byte _endianess)	Set the endianess for the connection Default is based on system endianess.
R	withErrorHandlerThreadCount(int _threads)	Deprecated, for removal: This API element is subject to removal in a future version. use receivingThreadConfig().withErrorHandlerThreadCount(_threads)
R	withMethodCallThreadCount(int _threads)	Deprecated, for removal: This API element is subject to removal in a future version. use receivingThreadConfig().withMethodCallThreadCount(_threads)
R	withMethodReturnThreadCount(int _threads)	Deprecated, for removal: This API element is subject to removal in a future version. use receivingThreadConfig().withMethodReturnThreadCount(_threads)
R	withSignalThreadCount(int _threads)	Deprecated, for removal: This API element is subject to removal in a future version. use receivingThreadConfig().withSignalThreadCount(_threads)
R	withWeakReferences(boolean _weakRef)	Enable/Disable weak references on connection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

returnType

private final Class<R extends BaseConnectionBuilder<R,C>> returnType

weakReference

private boolean weakReference

endianess

private byte endianess

disconnectCallback

private IDisconnectCallback disconnectCallback

rsConfigBuilder

private final ReceivingServiceConfigBuilder<R extends BaseConnectionBuilder<R,C>> rsConfigBuilder

transportConfigBuilder

private final TransportConfigBuilder<?,R extends BaseConnectionBuilder<R,C>> transportConfigBuilder

Constructor Details

BaseConnectionBuilder

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

Method Details

self

R self()

Return ourselves.

Returns:

concrete version of this

buildThreadConfig

protected ReceivingServiceConfig buildThreadConfig()

Creates the configuration to use for ReceivingService.

Returns:

config

buildTransportConfig

protected TransportConfig buildTransportConfig()

Creates the configuration to use for TransportBuilder.

Returns:

config

isWeakReference

protected boolean isWeakReference()

getEndianess

protected byte getEndianess()

getDisconnectCallback

protected IDisconnectCallback getDisconnectCallback()

receivingThreadConfig

public ReceivingServiceConfigBuilder<R> receivingThreadConfig()

Returns the builder to configure the receiving thread pools.

Returns:

builder

transportConfig

public TransportConfigBuilder<?,R> transportConfig()

Returns the builder to configure the used transport.

Returns:

builder

withSignalThreadCount

@Deprecated(since="4.2.0",
            forRemoval=true)
public R withSignalThreadCount(int _threads)

Deprecated, for removal: This API element is subject to removal in a future version.

use receivingThreadConfig().withSignalThreadCount(_threads)

Set the size of the thread-pool used to handle signals from the bus. Caution: Using thread-pool size > 1 may cause signals to be handled out-of-order

Default: 1

Parameters:

_threads - int >= 1

Returns:

this

withErrorHandlerThreadCount

@Deprecated(since="4.2.0",
            forRemoval=true)
public R withErrorHandlerThreadCount(int _threads)

Deprecated, for removal: This API element is subject to removal in a future version.

use receivingThreadConfig().withErrorHandlerThreadCount(_threads)

Set the size of the thread-pool used to handle error messages received on the bus.

Default: 1

Parameters:

_threads - int >= 1

Returns:

this

withMethodCallThreadCount

@Deprecated(since="4.2.0",
            forRemoval=true)
public R withMethodCallThreadCount(int _threads)

Deprecated, for removal: This API element is subject to removal in a future version.

use receivingThreadConfig().withMethodCallThreadCount(_threads)

Set the size of the thread-pool used to handle methods calls previously sent to the bus. The thread pool size has to be > 1 to handle recursive calls.

Default: 4

Parameters:

_threads - int >= 1

Returns:

this

withMethodReturnThreadCount

@Deprecated(since="4.2.0",
            forRemoval=true)
public R withMethodReturnThreadCount(int _threads)

Deprecated, for removal: This API element is subject to removal in a future version.

use receivingThreadConfig().withMethodReturnThreadCount(_threads)

Set the size of the thread-pool used to handle method return values received on the bus.

Default: 1

Parameters:

_threads - int >= 1

Returns:

this

withEndianess

public R withEndianess(byte _endianess)

Set the endianess for the connection Default is based on system endianess.

Parameters:

_endianess - Message.Endian.BIG or 0x6c

Returns:

this

withWeakReferences

public R withWeakReferences(boolean _weakRef)

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

Parameters:

_weakRef - true to enable

Returns:

this

withDisconnectCallback

public R withDisconnectCallback(IDisconnectCallback _disconnectCallback)

Set the given disconnect callback to the created connection.

Parameters:

_disconnectCallback - callback

Returns:

this

build

public abstract C build()
                 throws DBusException

Throws:

DBusException

getSystemEndianness

public static byte getSystemEndianness()

Get the default system endianness.

Returns:

LITTLE or BIG