rsb.transport.socket

Interface BusConnection

All Superinterfaces:

Activatable, AutoCloseable, Closeable

All Known Implementing Classes:

BusClientConnection, BusConnectionBase, BusServerConnection

public interface BusConnection
extends Activatable

Interface for connections to the socket based transport.

Author:

jwienke

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Method Summary

Methods

Modifier and Type	Method and Description
SocketOptions	getOptions() Returns the current configuration of the connection.
boolean	isActiveShutdown() Indicates whether the connection is currently performing an active shutdown as a consequence of calling shutdown().
NotificationType.Notification	readNotification() Reads a notification from the connection.
void	sendNotification(NotificationType.Notification notification) Sends a notification over the connection.
void	shutdown() This method starts and orderly shutdown of the connection.

Methods inherited from interface rsb.Activatable

activate, deactivate, isActive

Methods inherited from interface java.io.Closeable

close

Method Detail

sendNotification

void sendNotification(NotificationType.Notification notification)
                      throws IOException

Sends a notification over the connection.

Parameters:

notification - the notification to send. Must be complete so that it can be serialized.

Throws:

IOException - error sending the notification

readNotification

NotificationType.Notification readNotification()
                                               throws IOException

Reads a notification from the connection. Blocks if necessary.

Returns:

the read notification

Throws:

IOException - communication error

getOptions

SocketOptions getOptions()

Returns the current configuration of the connection.

Returns:

configuration of the connection

shutdown

void shutdown()
              throws IOException

This method starts and orderly shutdown of the connection. It needs to be called before Activatable.deactivate() for this procedure to succeed. Should be callable multiple times without raising an error. Calls after the first are usually ignored.

Throws:

IOException - error indicating the shutdown due to socket writing problems

isActiveShutdown

boolean isActiveShutdown()

Indicates whether the connection is currently performing an active shutdown as a consequence of calling shutdown().

Returns:

true in case of active shutdown, else false