Module org.freedesktop.dbus

Package org.freedesktop.dbus.connections.impl

Class DBusConnectionBuilder

java.lang.Object

org.freedesktop.dbus.connections.impl.DBusConnectionBuilder

public class DBusConnectionBuilder
extends Object

Builder to create a new DBusConnection.

Version:

4.1.0 - 2022-02-04

Author:

hypfvieh

Method Summary

Modifier and Type	Method	Description
DBusConnection	build()	Create the new DBusConnection.
static DBusConnectionBuilder	forAddress(String _address)	Use the given address to create the connection (e.g. used for remote TCP connected DBus daemons).
static DBusConnectionBuilder	forSessionBus()	Create a new default connection connecting to the DBus session bus.
static DBusConnectionBuilder	forSessionBus(String _machineIdFileLocation)	Create a new default connection connecting to DBus session bus but use an alternative input for the machineID.
static DBusConnectionBuilder	forSystemBus()	Create new default connection to the DBus system bus.
static DBusConnectionBuilder	forType(DBusConnection.DBusBusType _type)	Create a default connection to DBus using the given bus type.
static DBusConnectionBuilder	forType(DBusConnection.DBusBusType _type, String _machineIdFile)	Create a default connection to DBus using the given bus type and machineIdFile.
static byte	getSystemEndianness()	Get the default system endianness.
DBusConnectionBuilder	withDisconnectCallback(IDisconnectCallback _disconnectCallback)	Set the given disconnect callback to the created connection.
DBusConnectionBuilder	withEndianess(byte _endianess)	Set the endianess for the connection Default is based on system endianess.
DBusConnectionBuilder	withErrorHandlerThreadCount(int _threads)	Set the size of the thread-pool used to handle error messages received on the bus.
DBusConnectionBuilder	withMethodCallThreadCount(int _threads)	Set the size of the thread-pool used to handle methods calls previously sent to the bus.
DBusConnectionBuilder	withMethodReturnThreadCount(int _threads)	Set the size of the thread-pool used to handle method return values received on the bus.
DBusConnectionBuilder	withRegisterSelf(boolean _register)	Register the new connection on DBus using 'hello' message.
DBusConnectionBuilder	withShared(boolean _shared)	Use this connection as shared connection.
DBusConnectionBuilder	withSignalThreadCount(int _threads)	Set the size of the thread-pool used to handle signals from the bus.
DBusConnectionBuilder	withTimeout(int _timeout)	Set the timeout for the connection (used for TCP connections only).
DBusConnectionBuilder	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

Method Details

forSessionBus

public static DBusConnectionBuilder forSessionBus(String _machineIdFileLocation)

Create a new default connection connecting to DBus session bus but use an alternative input for the machineID.

Parameters:

_machineIdFileLocation - file with machine ID

Returns:

DBusConnectionBuilder

forSystemBus

public static DBusConnectionBuilder forSystemBus()

Create new default connection to the DBus system bus.

Returns:

DBusConnectionBuilder

forSessionBus

public static DBusConnectionBuilder forSessionBus()

Create a new default connection connecting to the DBus session bus.

Returns:

DBusConnectionBuilder

forType

public static DBusConnectionBuilder forType(DBusConnection.DBusBusType _type)

Create a default connection to DBus using the given bus type.

Parameters:

_type - bus type

Returns:

this

forType

public static DBusConnectionBuilder forType(DBusConnection.DBusBusType _type,
 String _machineIdFile)

Create a default connection to DBus using the given bus type and machineIdFile.

Parameters:

_type - bus type

_machineIdFile - machineId file

Returns:

this

forAddress

public static DBusConnectionBuilder forAddress(String _address)

Use the given address to create the connection (e.g. used for remote TCP connected DBus daemons).

Parameters:

_address - address to use

Returns:

this

withRegisterSelf

public DBusConnectionBuilder withRegisterSelf(boolean _register)

Register the new connection on DBus using 'hello' message. Default is true.

Parameters:

_register - boolean

Returns:

this

withShared

public DBusConnectionBuilder withShared(boolean _shared)

Use this connection as shared connection. Shared connection means that the same connection is used multiple times if the connection parameter did not change. Default is true.

Parameters:

_shared - boolean

Returns:

this

withTimeout

public DBusConnectionBuilder withTimeout(int _timeout)

Set the timeout for the connection (used for TCP connections only). Default is .

Parameters:

_timeout - timeout

Returns:

this

withSignalThreadCount

public DBusConnectionBuilder withSignalThreadCount(int _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

public DBusConnectionBuilder withErrorHandlerThreadCount(int _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

public DBusConnectionBuilder withMethodCallThreadCount(int _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

public DBusConnectionBuilder withMethodReturnThreadCount(int _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 DBusConnectionBuilder withEndianess(byte _endianess)

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

Parameters:

_endianess - or

Returns:

this

withDisconnectCallback

public DBusConnectionBuilder withDisconnectCallback(IDisconnectCallback _disconnectCallback)

Set the given disconnect callback to the created connection.

Parameters:

_disconnectCallback - callback

Returns:

this

withWeakReferences

public DBusConnectionBuilder withWeakReferences(boolean _weakRef)

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

Parameters:

_weakRef - true to enable

Returns:

this

build

public DBusConnection build()
                     throws DBusException

Create the new DBusConnection.

Returns:

DBusConnection

Throws:

DBusException - when DBusConnection could not be opened

getSystemEndianness

public static byte getSystemEndianness()

Get the default system endianness.

Returns:

LITTLE or BIG