Top Fields Constructors Methods
org.freedesktop.dbus.transport.junixsocket

public Class JUnixSocketSocketProvider

extends Object
implements ISocketProvider
Class Inheritance
All Implemented Interfaces
org.freedesktop.dbus.spi.message.ISocketProvider
Imports
org.freedesktop.dbus.spi.message.*, org.newsclub.net.unix.*, org.slf4j.Logger, .LoggerFactory, java.io.FileDescriptor, .IOException, java.nio.channels.SocketChannel, java.util.Optional

Field Summary

Modifier and TypeField and Description
private boolean
hasFileDescriptorSupport

private static final Logger
LOGGER

Constructor Summary

AccessConstructor and Description
public
JUnixSocketSocketProvider()

Method Summary

Modifier and TypeMethod and Description
public Optional<FileDescriptor>
createFileDescriptor(int
FileDescriptor to extract value from
_fd)

Overrides default org.freedesktop.dbus.spi.message.ISocketProvider.createFileDescriptor.

Attempts to create native FileDescriptor from raw int value.

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 Optional<Integer>
getFileDescriptorValue(FileDescriptor
FileDescriptor to extract value from
_fd)

Overrides default org.freedesktop.dbus.spi.message.ISocketProvider.getFileDescriptorValue.

Attempts to extract raw FileDescriptor value from FileDescriptor instance.

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

hasFileDescriptorSupportback to summary
private boolean hasFileDescriptorSupport
LOGGERback to summary
private static final Logger LOGGER

Constructor Detail

JUnixSocketSocketProviderback to summary
public JUnixSocketSocketProvider()

Method Detail

createFileDescriptorback to summary
public Optional<FileDescriptor> createFileDescriptor(int _fd)

Overrides default org.freedesktop.dbus.spi.message.ISocketProvider.createFileDescriptor.

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

Attempts to create native FileDescriptor from raw int value.

Parameters
_fd:int

FileDescriptor to extract value from

Returns:Optional<FileDescriptor>

FileDescriptor, instantiated with provided value, packed to Optional if operation succeeded, or Optional#empty() otherwise

Annotations
@Override
createReaderback to summary
public IMessageReader createReader(SocketChannel _socket)

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
createWriterback to summary
public IMessageWriter createWriter(SocketChannel _socket)

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
getFileDescriptorValueback to summary
public Optional<Integer> getFileDescriptorValue(FileDescriptor _fd)

Overrides default org.freedesktop.dbus.spi.message.ISocketProvider.getFileDescriptorValue.

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

Attempts to extract raw FileDescriptor value from FileDescriptor instance. Note that not any FileDescriptor can be represented as int, for example Windows uses HANDLE as descriptor, which excess range of int values, thus cannot be safely cast to int.

Parameters
_fd:FileDescriptor

FileDescriptor to extract value from

Returns:Optional<Integer>

int representation, packed to Optional if operation succeeded, or Optional#empty() otherwise

Annotations
@Override
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