dbus-java 5.1.1 · org.freedesktop.dbus.connections.config.ReceivingServiceConfigBuilder

Modifier and Type	Field and Description
private final ReceivingServiceConfig	config
private final Supplier<R>	connectionBuilder
private static final ReceivingServiceConfig	DEFAULT_CFG
public static final int	DEFAULT_HANDLER_RETRIES
private static final IThreadPoolRetryHandler	DEFAULT_RETRYHANDLER

Access	Constructor and Description
public	ReceivingServiceConfigBuilder(Supplier<R> _bldr)

Method Summary

Modifier and Type	Method and Description
public ReceivingServiceConfig	Returns: config never null build() Returns the configured `ReceivingServiceConfig` instance.
public R	Returns: connection builder connectionConfig() Returns the used ConnectionBuilder for the connection for further configuration.
public static ReceivingServiceConfig	Returns: default config getDefaultConfig() Returns the default configuration used for `ReceivingService`.
public static IThreadPoolRetryHandler	Returns: default handler getDefaultRetryHandler() Returns the default retry handler used for `ReceivingService`.
public ReceivingServiceConfigBuilder<R>	Returns: this withErrorHandlerThreadCount(int int >= 1 _threads) Set the size of the thread-pool used to handle error messages received on the bus.
public ReceivingServiceConfigBuilder<R>	Returns: this withErrorThreadPriority(int int >=1 and <= 10 _priority) Sets the thread priority of the created signal thread(s).
public ReceivingServiceConfigBuilder<R>	Returns: this withMethedCallThreadPriority(int int >=1 and <= 10 _priority) Sets the thread priority of the created signal thread(s).
public ReceivingServiceConfigBuilder<R>	Returns: this withMethodCallThreadCount(int int >= 1 _threads) Set the size of the thread-pool used to handle methods calls previously sent to the bus.
public ReceivingServiceConfigBuilder<R>	Returns: this withMethodReturnThreadCount(int int >= 1 _threads) Set the size of the thread-pool used to handle method return values received on the bus.
public ReceivingServiceConfigBuilder<R>	Returns: this withMethodReturnThreadPriority(int int >=1 and <= 10 _priority) Sets the thread priority of the created signal thread(s).
public ReceivingServiceConfigBuilder<R>	Returns: this withRetryHandler(IThreadPoolRetryHandler handler to use _handler) Sets the retry handler which should be called when executing a runnable in `ReceivingService` thread pools fail.
public ReceivingServiceConfigBuilder<R>	Returns: this withSignalThreadCount(int int >= 1 _threads) Set the size of the thread-pool used to handle signals from the bus.
public ReceivingServiceConfigBuilder<R>	Returns: this withSignalThreadPriority(int int >=1 and <= 10 _priority) Sets the thread priority of the created signal thread(s).

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

config	back to summary
private final ReceivingServiceConfig config

connectionBuilder	back to summary
private final Supplier<R> connectionBuilder

DEFAULT_CFG	back to summary
private static final ReceivingServiceConfig DEFAULT_CFG

DEFAULT_HANDLER_RETRIES	back to summary
public static final int DEFAULT_HANDLER_RETRIES

DEFAULT_RETRYHANDLER	back to summary
private static final IThreadPoolRetryHandler DEFAULT_RETRYHANDLER

ReceivingServiceConfigBuilder	back to summary
public ReceivingServiceConfigBuilder(Supplier<R> _bldr)

Method Detail

build back to summary

build	back to summary
public ReceivingServiceConfig build() Returns the configured `ReceivingServiceConfig` instance. Returns:ReceivingServiceConfig config never null

public ReceivingServiceConfig build()

Returns the configured ReceivingServiceConfig instance.

Returns:ReceivingServiceConfig: config never null

connectionConfig	back to summary
public R connectionConfig() Returns the used ConnectionBuilder for the connection for further configuration. Returns:R connection builder

connectionConfig

back to summary

public R connectionConfig()

Returns the used ConnectionBuilder for the connection for further configuration.

Returns:R: connection builder

getDefaultConfig back to summary

getDefaultConfig	back to summary
public static ReceivingServiceConfig getDefaultConfig() Returns the default configuration used for `ReceivingService`. Returns:ReceivingServiceConfig default config

public static ReceivingServiceConfig getDefaultConfig()

Returns the default configuration used for ReceivingService.

Returns:ReceivingServiceConfig: default config

getDefaultRetryHandler back to summary

getDefaultRetryHandler	back to summary
public static IThreadPoolRetryHandler getDefaultRetryHandler() Returns the default retry handler used for `ReceivingService`. Returns:IThreadPoolRetryHandler default handler

public static IThreadPoolRetryHandler getDefaultRetryHandler()

Returns the default retry handler used for ReceivingService.

Returns:IThreadPoolRetryHandler: default handler

withErrorHandlerThreadCount	back to summary
public ReceivingServiceConfigBuilder<R> withErrorHandlerThreadCount(int _threads) Set the size of the thread-pool used to handle error messages received on the bus. Default: 1 Parameters _threads:int int >= 1 Returns:ReceivingServiceConfigBuilder<R> this

withErrorHandlerThreadCount

back to summary

public ReceivingServiceConfigBuilder<R> withErrorHandlerThreadCount(int _threads)

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

Default: 1

Parameters

_threads:int: int >= 1

Returns:ReceivingServiceConfigBuilder<R>

this

withErrorThreadPriority back to summary

withErrorThreadPriority	back to summary
public ReceivingServiceConfigBuilder<R> withErrorThreadPriority(int _priority) Sets the thread priority of the created signal thread(s). Default: `Thread#NORM_PRIORITY` (5); Parameters _priority:int int >=1 and <= 10 Returns:ReceivingServiceConfigBuilder<R> this Exceptions IllegalArgumentException: when value is out ouf range (value < 1 && > 10)

public ReceivingServiceConfigBuilder<R> withErrorThreadPriority(int _priority)

Sets the thread priority of the created signal thread(s).

Default: Thread#NORM_PRIORITY (5);

Parameters

_priority:int: int >=1 and <= 10

Returns:ReceivingServiceConfigBuilder<R>

this

Exceptions

IllegalArgumentException:: when value is out ouf range (value < 1 && > 10)

withMethedCallThreadPriority back to summary

withMethedCallThreadPriority	back to summary
public ReceivingServiceConfigBuilder<R> withMethedCallThreadPriority(int _priority) Sets the thread priority of the created signal thread(s). Default: `Thread#NORM_PRIORITY` (5); Parameters _priority:int int >=1 and <= 10 Returns:ReceivingServiceConfigBuilder<R> this Exceptions IllegalArgumentException: when value is out ouf range (value < 1 && > 10)

public ReceivingServiceConfigBuilder<R> withMethedCallThreadPriority(int _priority)

Sets the thread priority of the created signal thread(s).

Default: Thread#NORM_PRIORITY (5);

Parameters

_priority:int: int >=1 and <= 10

Returns:ReceivingServiceConfigBuilder<R>

this

Exceptions

IllegalArgumentException:: when value is out ouf range (value < 1 && > 10)

withMethodCallThreadCount	back to summary
public ReceivingServiceConfigBuilder<R> 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 int >= 1 Returns:ReceivingServiceConfigBuilder<R> this

withMethodCallThreadCount

back to summary

public ReceivingServiceConfigBuilder<R> 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: int >= 1

Returns:ReceivingServiceConfigBuilder<R>

this

withMethodReturnThreadCount	back to summary
public ReceivingServiceConfigBuilder<R> 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 int >= 1 Returns:ReceivingServiceConfigBuilder<R> this

withMethodReturnThreadCount

back to summary

public ReceivingServiceConfigBuilder<R> 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: int >= 1

Returns:ReceivingServiceConfigBuilder<R>

this

withMethodReturnThreadPriority back to summary

withMethodReturnThreadPriority	back to summary
public ReceivingServiceConfigBuilder<R> withMethodReturnThreadPriority(int _priority) Sets the thread priority of the created signal thread(s). Default: `Thread#NORM_PRIORITY` (5); Parameters _priority:int int >=1 and <= 10 Returns:ReceivingServiceConfigBuilder<R> this Exceptions IllegalArgumentException: when value is out ouf range (value < 1 && > 10)

public ReceivingServiceConfigBuilder<R> withMethodReturnThreadPriority(int _priority)

Sets the thread priority of the created signal thread(s).

Default: Thread#NORM_PRIORITY (5);

Parameters

_priority:int: int >=1 and <= 10

Returns:ReceivingServiceConfigBuilder<R>

this

Exceptions

IllegalArgumentException:: when value is out ouf range (value < 1 && > 10)

withRetryHandler back to summary

withRetryHandler	back to summary
public ReceivingServiceConfigBuilder<R> withRetryHandler(IThreadPoolRetryHandler _handler) Sets the retry handler which should be called when executing a runnable in `ReceivingService` thread pools fail. Defaults to an implementation retrying executing the runnable up to ten times. If `null` is given, retrying will be disabled (but error will be logged). Parameters _handler:IThreadPoolRetryHandler handler to use Returns:ReceivingServiceConfigBuilder<R> this

public ReceivingServiceConfigBuilder<R> withRetryHandler(IThreadPoolRetryHandler _handler)

Sets the retry handler which should be called when executing a runnable in ReceivingService thread pools fail.

Defaults to an implementation retrying executing the runnable up to ten times. If null is given, retrying will be disabled (but error will be logged).

Parameters

_handler:IThreadPoolRetryHandler: handler to use

Returns:ReceivingServiceConfigBuilder<R>

this

withSignalThreadCount	back to summary
public ReceivingServiceConfigBuilder<R> 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 int >= 1 Returns:ReceivingServiceConfigBuilder<R> this

withSignalThreadCount

back to summary

public ReceivingServiceConfigBuilder<R> 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: int >= 1

Returns:ReceivingServiceConfigBuilder<R>

this

withSignalThreadPriority back to summary

withSignalThreadPriority	back to summary
public ReceivingServiceConfigBuilder<R> withSignalThreadPriority(int _priority) Sets the thread priority of the created signal thread(s). Default: `Thread#NORM_PRIORITY` (5); Parameters _priority:int int >=1 and <= 10 Returns:ReceivingServiceConfigBuilder<R> this Exceptions IllegalArgumentException: when value is out ouf range (value < 1 && > 10)

public ReceivingServiceConfigBuilder<R> withSignalThreadPriority(int _priority)

Sets the thread priority of the created signal thread(s).

Default: Thread#NORM_PRIORITY (5);

Parameters

_priority:int: int >=1 and <= 10

Returns:ReceivingServiceConfigBuilder<R>

this

Exceptions

IllegalArgumentException:: when value is out ouf range (value < 1 && > 10)

public final Class ReceivingServiceConfigBuilder<R extends BaseConnectionBuilder<?, ?>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail