Module org.freedesktop.dbus

Package org.freedesktop.dbus.spi.transport

Interface ITransportProvider

public interface ITransportProvider

Interface used by ServiceLoader to provide a transport used by DBus.

Since:

v4.0.0 - 2021-09-05

Author:

hypfvieh

Method Summary

Modifier and Type	Method	Description
String	createDynamicSessionAddress(boolean _listeningSocket)	Creates a new (dynamic) session for this transport.
default AbstractTransport	createTransport(BusAddress _address, int _timeout)	Deprecated, for removal: This API element is subject to removal in a future version. just used for compatibility will be removed in the future.
AbstractTransport	createTransport(BusAddress _address, TransportConfig _config)	Creates a new instance of this transport service using the given bus address.
String	getSupportedBusType()	Type of transport.
String	getTransportName()	Name of the transport implementation.

Method Details

getTransportName

String getTransportName()

Name of the transport implementation.

Returns:

String, should not be null or empty

createTransport

AbstractTransport createTransport(BusAddress _address,
 TransportConfig _config)
                           throws TransportConfigurationException

Creates a new instance of this transport service using the given bus address.

If transport cannot be created because bus address type is not supported, null should be returned. If initialization fails because of any other error, throw a TransportConfigurationException.

Parameters:

_address - bus address

_config - configuration for this transport

Returns:

transport instance or null

Throws:

TransformerConfigurationException - when configuring transport fails

TransportConfigurationException

createTransport

@Deprecated(since="4.2.0 - 2022-07-21",
            forRemoval=true)
default AbstractTransport createTransport(BusAddress _address,
 int _timeout)
                                   throws TransportConfigurationException

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

just used for compatibility will be removed in the future. Please use createTransport(BusAddress, TransportConfig).

Creates a new instance of this transport service using the given bus address and timeout. This method is only implemented for compatibility to older transports. It will be removed in the future. Please use createTransport(BusAddress, TransportConfig) instead.

Parameters:

_address - bus address

_timeout - timeout to use (if supported)

Returns:

transport instance or null

Throws:

TransformerConfigurationException - when configuring transport fails

TransportConfigurationException

getSupportedBusType

String getSupportedBusType()

Type of transport. Should return an identifier for the supported socket type (e.g. UNIX for unix socket, TCP for tcp sockets).

Returns:

String, never null

createDynamicSessionAddress

String createDynamicSessionAddress(boolean _listeningSocket)

Creates a new (dynamic) session for this transport.

Parameters:

_listeningSocket - true when listening address should be created

Returns:

String containing bus address