dbus-java 5.1.1 · org.freedesktop.dbus.spi.message.AbstractOutputStreamMessageWriter

Modifier and Type	Field and Description
private final Logger	logger
private final SocketChannel	outputChannel
private final ISocketProvider	socketProviderImpl

Access	Constructor and Description
protected	AbstractOutputStreamMessageWriter(final SocketChannel _out, ISocketProvider _socketProviderImpl)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
protected Logger	getLogger()
protected ISocketProvider	getSocketProviderImpl()
public boolean	isClosed() Implements org.freedesktop.dbus.spi.message.IMessageWriter.isClosed.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected abstract void	writeFileDescriptors(SocketChannel channel to write to _outputChannel, List<FileDescriptor> file descriptors attached to message _filedescriptors) Called to write any file descriptors to the given channel.
public final void	writeMessage(Message The message to write _msg) Implements org.freedesktop.dbus.spi.message.IMessageWriter.writeMessage. Write a message out to the bus.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

logger	back to summary
private final Logger logger

outputChannel	back to summary
private final SocketChannel outputChannel

socketProviderImpl	back to summary
private final ISocketProvider socketProviderImpl

AbstractOutputStreamMessageWriter	back to summary
protected AbstractOutputStreamMessageWriter(final SocketChannel _out, ISocketProvider _socketProviderImpl)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

getLogger	back to summary
protected Logger getLogger()

getSocketProviderImpl	back to summary
protected ISocketProvider getSocketProviderImpl()

isClosed	back to summary
public boolean isClosed() Implements org.freedesktop.dbus.spi.message.IMessageWriter.isClosed. Annotations @Override

isClosed

back to summary

public boolean isClosed()

Implements org.freedesktop.dbus.spi.message.IMessageWriter.isClosed.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

writeFileDescriptors	back to summary
protected abstract void writeFileDescriptors(SocketChannel _outputChannel, List<FileDescriptor> _filedescriptors) throws IOException Called to write any file descriptors to the given channel. Should do nothing if there is no file descriptor to write, or method is not supported. Parameters _outputChannel:SocketChannel channel to write to _filedescriptors:List<FileDescriptor> file descriptors attached to message Exceptions IOException: when writing the descriptors fail

writeFileDescriptors

back to summary

protected abstract void writeFileDescriptors(SocketChannel _outputChannel, List<FileDescriptor> _filedescriptors) throws IOException

Called to write any file descriptors to the given channel.
Should do nothing if there is no file descriptor to write, or method is not supported.

Parameters

_outputChannel:SocketChannel: channel to write to
_filedescriptors:List<FileDescriptor>: file descriptors attached to message

Exceptions

IOException:: when writing the descriptors fail

writeMessage	back to summary
public final void writeMessage(Message _msg) throws IOException Implements org.freedesktop.dbus.spi.message.IMessageWriter.writeMessage. Doc from org.freedesktop.dbus.spi.message.IMessageWriter.writeMessage. Write a message out to the bus. Parameters _msg:Message The message to write Annotations @Override Exceptions IOException: If an IO error occurs.

writeMessage

back to summary

public final void writeMessage(Message _msg) throws IOException

Implements org.freedesktop.dbus.spi.message.IMessageWriter.writeMessage.

Doc from org.freedesktop.dbus.spi.message.IMessageWriter.writeMessage.

Write a message out to the bus.

Parameters