Top Description Fields Constructors Methods
org.freedesktop.dbus.transport.tcp

public Class TcpTransport

extends AbstractTransport
Class Inheritance
Imports
org.freedesktop.dbus.connections.BusAddress, .SASL, org.freedesktop.dbus.connections.config.TransportConfig, org.freedesktop.dbus.connections.transports.AbstractTransport, java.io.IOException, java.net.InetSocketAddress, java.nio.channels.ServerSocketChannel, .SocketChannel
Transport type representing a transport connection to TCP.
Author
hypfvieh
Since
v3.2.0 - 2019-02-08

Field Summary

Modifier and TypeField and Description
private ServerSocketChannel
serverSocket

private SocketChannel
socket

private final int
timeout

Constructor Summary

AccessConstructor and Description
pack-priv
TcpTransport(BusAddress _address, int _timeout, TransportConfig _config)

Method Summary

Modifier and TypeMethod and Description
protected SocketChannel
acceptImpl()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.acceptImpl.

Method to accept new incoming listening connections.

protected void
bindImpl()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.bindImpl.

Listen for new connections using TCP.

protected void
closeTransport()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.closeTransport.

Method which is called to close a transport.

public SocketChannel
connectImpl()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.connectImpl.

Connect to DBus using TCP.

public TcpBusAddress
getAddress()

Overrides org.freedesktop.dbus.connections.transports.AbstractTransport.getAddress.

Returns the BusAddress used for this transport.

protected boolean
hasFileDescriptorSupport()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.hasFileDescriptorSupport.

Method to indicate if passing of file descriptors is allowed.

protected boolean
isBound()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.isBound.

Status of the server socket if this transport is configured to be a server connection.

Inherited from org.freedesktop.dbus.connections.transports.AbstractTransport:
closeconnectgetLoggergetMessageFactorygetSaslConfiggetTransportConfiggetTransportConnectionisConnectedisFileDescriptorSupportedisListeninglistenreadMessagesetPreConnectCallbacktoStringwriteMessage

Field Detail

serverSocketback to summary
private ServerSocketChannel serverSocket
socketback to summary
private SocketChannel socket
timeoutback to summary
private final int timeout

Constructor Detail

TcpTransportback to summary
pack-priv TcpTransport(BusAddress _address, int _timeout, TransportConfig _config)

Method Detail

acceptImplback to summary
protected SocketChannel acceptImpl() throws IOException

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.acceptImpl.

Doc from org.freedesktop.dbus.connections.transports.AbstractTransport.acceptImpl.

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

Returns:SocketChannel

newly connected client socket

Annotations
@Override
Exceptions
IOException:
when connection fails
bindImplback to summary
protected void bindImpl() throws IOException

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.bindImpl.

Listen for new connections using TCP.

Annotations
@Override
Exceptions
IOException:
on error
closeTransportback to summary
protected void closeTransport() throws IOException

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.closeTransport.

Doc from org.freedesktop.dbus.connections.transports.AbstractTransport.closeTransport.

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

Annotations
@Override
Exceptions
IOException:
when something fails while closing transport
connectImplback to summary
public SocketChannel connectImpl() throws IOException

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.connectImpl.

Connect to DBus using TCP.

Returns:SocketChannel

Doc from org.freedesktop.dbus.connections.transports.AbstractTransport.connectImpl.

socket channel connected to DBus server

Annotations
@Override
Exceptions
IOException:
on error
getAddressback to summary
public TcpBusAddress getAddress()

Overrides org.freedesktop.dbus.connections.transports.AbstractTransport.getAddress.

Doc from org.freedesktop.dbus.connections.transports.AbstractTransport.getAddress.

Returns the BusAddress used for this transport.

Returns:TcpBusAddress

BusAddress, never null

Annotations
@Override
hasFileDescriptorSupportback to summary
protected boolean hasFileDescriptorSupport()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.hasFileDescriptorSupport.

Doc from org.freedesktop.dbus.connections.transports.AbstractTransport.hasFileDescriptorSupport.

Method to indicate if passing of file descriptors is allowed.

Returns:boolean

true to allow FD passing, false otherwise

Annotations
@Override
isBoundback to summary
protected boolean isBound()

Implements abstract org.freedesktop.dbus.connections.transports.AbstractTransport.isBound.

Doc from org.freedesktop.dbus.connections.transports.AbstractTransport.isBound.

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

Returns:boolean

boolean

Annotations
@Override