Module org.freedesktop.dbus.transport.tcp

Package org.freedesktop.dbus.transport.tcp

Class TcpTransport

java.lang.Object

org.freedesktop.dbus.connections.transports.AbstractTransport

org.freedesktop.dbus.transport.tcp.TcpTransport

All Implemented Interfaces:

Closeable, AutoCloseable

public class TcpTransport
extends AbstractTransport

Transport type representing a transport connection to TCP.

Since:

v3.2.0 - 2019-02-08

Field Summary

Fields

Modifier and Type	Field	Description
private ServerSocketChannel	serverSocket
private SocketChannel	socket
private final int	timeout

Constructor Summary

Constructors

Constructor	Description
TcpTransport(BusAddress _address, int _timeout, TransportConfig _config)

Method Summary

Modifier and Type	Method	Description
protected SocketChannel	acceptImpl()	Method to accept new incoming listening connections. This is the place where accept() is called on the server socket created by AbstractTransport.bindImpl(). Therefore this method will block until a client is connected.
protected void	bindImpl()	Listen for new connections using TCP.
protected void	closeTransport()	Method which is called to close a transport. Should be used to close all sockets and/or serversockets.
SocketChannel	connectImpl()	Connect to DBus using TCP.
TcpBusAddress	getAddress()	Returns the BusAddress used for this transport.
protected boolean	hasFileDescriptorSupport()	Method to indicate if passing of file descriptors is allowed.
protected boolean	isBound()	Status of the server socket if this transport is configured to be a server connection. Must be false if AbstractTransport.bindImpl() was not called.

Methods inherited from class org.freedesktop.dbus.connections.transports.AbstractTransport

close, connect, getLogger, getMessageFactory, getSaslConfig, getTransportConfig, getTransportConnection, isConnected, isFileDescriptorSupported, isListening, listen, readMessage, setPreConnectCallback, toString, writeMessage

Methods inherited from class java.lang.Object

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

Field Details

timeout

private final int timeout

socket

private SocketChannel socket

serverSocket

private ServerSocketChannel serverSocket

Constructor Details

TcpTransport

TcpTransport(BusAddress _address,
 int _timeout,
 TransportConfig _config)

Method Details

hasFileDescriptorSupport

protected boolean hasFileDescriptorSupport()

Description copied from class: AbstractTransport

Method to indicate if passing of file descriptors is allowed.

Specified by:

hasFileDescriptorSupport in class AbstractTransport

Returns:

true to allow FD passing, false otherwise

getAddress

public TcpBusAddress getAddress()

Description copied from class: AbstractTransport

Returns the BusAddress used for this transport.

Overrides:

getAddress in class AbstractTransport

Returns:

BusAddress, never null

isBound

protected boolean isBound()

Description copied from class: AbstractTransport

Status of the server socket if this transport is configured to be a server connection.
Must be false if AbstractTransport.bindImpl() was not called.

Specified by:

isBound in class AbstractTransport

Returns:

boolean

bindImpl

protected void bindImpl()
                 throws IOException

Listen for new connections using TCP.

Specified by:

bindImpl in class AbstractTransport

Throws:

IOException - on error

acceptImpl

protected SocketChannel acceptImpl()
                            throws IOException

Description copied from class: AbstractTransport

Method to accept new incoming listening connections.
This is the place where accept() is called on the server socket created by AbstractTransport.bindImpl().
Therefore this method will block until a client is connected.

Specified by:

acceptImpl in class AbstractTransport

Returns:

newly connected client socket

Throws:

IOException - when connection fails

connectImpl

public SocketChannel connectImpl()
                          throws IOException

Connect to DBus using TCP.

Specified by:

connectImpl in class AbstractTransport

Returns:

socket channel connected to DBus server

Throws:

IOException - on error

closeTransport

protected void closeTransport()
                       throws IOException

Description copied from class: AbstractTransport

Method which is called to close a transport.
Should be used to close all sockets and/or serversockets.

Specified by:

closeTransport in class AbstractTransport

Throws:

IOException - when something fails while closing transport