Module org.freedesktop.dbus

Package org.freedesktop.dbus.spi.message

Class DefaultSocketProvider

java.lang.Object

org.freedesktop.dbus.spi.message.DefaultSocketProvider

All Implemented Interfaces:

ISocketProvider

final class DefaultSocketProvider
extends Object
implements ISocketProvider

Default internally used socket provider implementation.

Since:

5.0.0 - 2023-10-09

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final ISocketProvider	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefaultSocketProvider()

Method Summary

Modifier and Type	Method	Description
IMessageReader	createReader(SocketChannel _socket)	Method to create a IMessageReader implementation.
IMessageWriter	createWriter(SocketChannel _socket)	Method to create a IMessageWriter implementation.
boolean	isFileDescriptorPassingSupported()	Indicate if reader/writer supports file descriptor passing.
void	setFileDescriptorSupport(boolean _support)	Called to indicate if the current AbstractTransport implementation supports file descriptor passing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.freedesktop.dbus.spi.message.ISocketProvider

createFileDescriptor, getFileDescriptorValue

Field Details

INSTANCE

static final ISocketProvider INSTANCE

Constructor Details

DefaultSocketProvider

private DefaultSocketProvider()

Method Details

createReader

public IMessageReader createReader(SocketChannel _socket)
                            throws IOException

Description copied from interface: ISocketProvider

Method to create a IMessageReader implementation.

Specified by:

createReader in interface ISocketProvider

Parameters:

_socket - socket to use for reading

Returns:

MessageReader

Throws:

IOException - if reader could not be created

createWriter

public IMessageWriter createWriter(SocketChannel _socket)
                            throws IOException

Description copied from interface: ISocketProvider

Method to create a IMessageWriter implementation.

Specified by:

createWriter in interface ISocketProvider

Parameters:

_socket - socket to write to

Returns:

MessageWriter

Throws:

IOException - if write could not be created

setFileDescriptorSupport

public void setFileDescriptorSupport(boolean _support)

Description copied from interface: ISocketProvider

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

Specified by:

setFileDescriptorSupport in interface ISocketProvider

Parameters:

_support - true if file descriptor passing is supported, false otherwise

isFileDescriptorPassingSupported

public boolean isFileDescriptorPassingSupported()

Description copied from interface: ISocketProvider

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

Specified by:

isFileDescriptorPassingSupported in interface ISocketProvider

Returns:

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