Module org.freedesktop.dbus

Package org.freedesktop.dbus.spi.message

Class AbstractInputStreamMessageReader

java.lang.Object

org.freedesktop.dbus.spi.message.AbstractInputStreamMessageReader

All Implemented Interfaces:

Closeable, AutoCloseable, IMessageReader

Direct Known Subclasses:

InputStreamMessageReader

public abstract class AbstractInputStreamMessageReader
extends Object
implements IMessageReader

Base class which can be used to implement a custom message reader.

Since:

4.3.1 - 2023-08-07

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	body
private final byte[]	buf
private byte[]	header
private final SocketChannel	inputChannel
private final int[]	len
private final org.slf4j.Logger	logger
private final ISocketProvider	socketProviderImpl
private final byte[]	tbuf

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractInputStreamMessageReader(SocketChannel _in, ISocketProvider _socketProviderImpl)

Method Summary

Modifier and Type	Method	Description
void	close()
protected org.slf4j.Logger	getLogger()
protected ISocketProvider	getSocketProviderImpl()
boolean	isClosed()
protected abstract List<FileDescriptor>	readFileDescriptors(SocketChannel _inputChannel)	Methods which will be called when file descriptor passing is enabled.
final Message	readMessage()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

logger

private final org.slf4j.Logger logger

len

private final int[] len

buf

private final byte[] buf

tbuf

private final byte[] tbuf

inputChannel

private final SocketChannel inputChannel

header

private byte[] header

body

private byte[] body

socketProviderImpl

private final ISocketProvider socketProviderImpl

Constructor Details

AbstractInputStreamMessageReader

protected AbstractInputStreamMessageReader(SocketChannel _in,
 ISocketProvider _socketProviderImpl)

Method Details

readMessage

public final Message readMessage()
                          throws IOException,
DBusException

Specified by:

readMessage in interface IMessageReader

Throws:

IOException

DBusException

readFileDescriptors

protected abstract List<FileDescriptor> readFileDescriptors(SocketChannel _inputChannel)
                                                     throws DBusException

Methods which will be called when file descriptor passing is enabled. The implementation should fetch all file descriptors which have been transmitted and return them as List. If no file descriptor is available or feature is not supported, return null.

Parameters:

_inputChannel - input channel to read

Returns:

List or null

Throws:

DBusException - when reading throws exceptions

getLogger

protected org.slf4j.Logger getLogger()

getSocketProviderImpl

protected ISocketProvider getSocketProviderImpl()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface IMessageReader

toString

public String toString()

Overrides:

toString in class Object