Top Description Fields Constructors Methods
org.freedesktop.dbus.spi.message

pack-priv final Class DefaultSocketProvider

extends Object
implements ISocketProvider
Class Inheritance
All Implemented Interfaces
org.freedesktop.dbus.spi.message.ISocketProvider
Imports
java.io.IOException, java.nio.channels.SocketChannel
Default internally used socket provider implementation.
Author
hypfvieh
Since
5.0.0 - 2023-10-09

Field Summary

Modifier and TypeField and Description
pack-priv static final ISocketProvider
INSTANCE

Constructor Summary

AccessConstructor and Description
private
DefaultSocketProvider()

Method Summary

Modifier and TypeMethod and Description
public IMessageReader
createReader(SocketChannel
socket to use for reading
_socket)

Implements org.freedesktop.dbus.spi.message.ISocketProvider.createReader.

Method to create a IMessageReader implementation.

public IMessageWriter
createWriter(SocketChannel
socket to write to
_socket)

Implements org.freedesktop.dbus.spi.message.ISocketProvider.createWriter.

Method to create a IMessageWriter implementation.

public boolean
isFileDescriptorPassingSupported()

Implements org.freedesktop.dbus.spi.message.ISocketProvider.isFileDescriptorPassingSupported.

Indicate if reader/writer supports file descriptor passing.

public void
setFileDescriptorSupport(boolean
true if file descriptor passing is supported, false otherwise
_support)

Implements org.freedesktop.dbus.spi.message.ISocketProvider.setFileDescriptorSupport.

Called to indicate if the current AbstractTransport implementation supports file descriptor passing.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
pack-priv static final ISocketProvider INSTANCE

Constructor Detail

DefaultSocketProviderback to summary
private DefaultSocketProvider()

Method Detail

createReaderback to summary
public IMessageReader createReader(SocketChannel _socket) throws IOException

Implements org.freedesktop.dbus.spi.message.ISocketProvider.createReader.

Doc from org.freedesktop.dbus.spi.message.ISocketProvider.createReader.

Method to create a IMessageReader implementation.

Parameters
_socket:SocketChannel

socket to use for reading

Returns:IMessageReader

MessageReader

Annotations
@Override
Exceptions
IOException:
if reader could not be created
createWriterback to summary
public IMessageWriter createWriter(SocketChannel _socket) throws IOException

Implements org.freedesktop.dbus.spi.message.ISocketProvider.createWriter.

Doc from org.freedesktop.dbus.spi.message.ISocketProvider.createWriter.

Method to create a IMessageWriter implementation.

Parameters
_socket:SocketChannel

socket to write to

Returns:IMessageWriter

MessageWriter

Annotations
@Override
Exceptions
IOException:
if write could not be created
isFileDescriptorPassingSupportedback to summary
public boolean isFileDescriptorPassingSupported()

Implements org.freedesktop.dbus.spi.message.ISocketProvider.isFileDescriptorPassingSupported.

Doc from org.freedesktop.dbus.spi.message.ISocketProvider.isFileDescriptorPassingSupported.

Indicate if reader/writer supports file descriptor passing. This is to show if the provider is able to handle file descriptors.

Returns:boolean

true if file descriptors are supported by this provider, false otherwise

Annotations
@Override
setFileDescriptorSupportback to summary
public void setFileDescriptorSupport(boolean _support)

Implements org.freedesktop.dbus.spi.message.ISocketProvider.setFileDescriptorSupport.

Doc from org.freedesktop.dbus.spi.message.ISocketProvider.setFileDescriptorSupport.

Called to indicate if the current AbstractTransport implementation supports file descriptor passing.

Parameters
_support:boolean

true if file descriptor passing is supported, false otherwise

Annotations
@Override