Module org.newsclub.net.unix.tipc

Package org.newsclub.net.unix.tipc

Class AFTIPCTopologyWatcher

java.lang.Object

org.newsclub.net.unix.tipc.AFTIPCTopologyWatcher

All Implemented Interfaces:

Closeable, AutoCloseable

public class AFTIPCTopologyWatcher
extends Object
implements Closeable

Provides access to the TIPC topology service.

Author:

Christian Kohlschütter

Constructor Summary

Constructors

Constructor	Description
AFTIPCTopologyWatcher()	Creates an AFTIPCTopologyWatcher whose subscription requests do not time out by default.
AFTIPCTopologyWatcher(int defaultTimeoutSeconds)	Creates an AFTIPCTopologyWatcher whose subscription requests use the given default timeout.

Method Summary

Modifier and Type	Method	Description
final AFTIPCTopologySubscription	addLinkStateSubscription()	Watches for all link state changes.
final AFTIPCTopologySubscription	addPortSubscription()	Watches for all port changes.
final AFTIPCTopologySubscription	addPortSubscription(int port)	Watches for port changes of the given port ("port" meaning TIPC port, not TCP).
final AFTIPCTopologySubscription	addPortSubscription(int lower, int upper)	Watches for port changes within the given range ("port" meaning TIPC port, not TCP).
final AFTIPCTopologySubscription	addServiceSubscription(int type)	Watches for service changes of the given service type, matching any instance.
final AFTIPCTopologySubscription	addServiceSubscription(int type, int instance)	Watches for service changes of the given service type, matching only the specified instance.
final AFTIPCTopologySubscription	addServiceSubscription(int type, int lower, int upper)	Watches for service changes of the given service type and instance range.
final void	cancelSubscription(AFTIPCTopologySubscription sub)	Cancels a previously added service subscription.
final void	close()	Closes this instance.
protected final void	finalize()	Deprecated.
boolean	isRunning()	Checks if the watcher run loop is running.
protected void	onClose()	Called upon close().
protected void	onEvent(AFTIPCTopologyEvent event)	Called for every event encountered by the run loop.
final void	runLoop()	Runs a receive loop until stopLoop() or close() is called.
final AFTIPCTopologySubscription	sendMessage(AFTIPCTopologySubscription sub)	Sends a manually crafted subscription message to the TIPC topology server.
final void	stopLoop()	Stops the run loop.

Methods inherited from class java.lang.Object

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

Constructor Details

AFTIPCTopologyWatcher

public AFTIPCTopologyWatcher()
                      throws IOException

Creates an AFTIPCTopologyWatcher whose subscription requests do not time out by default.

Throws:

IOException - on error.

AFTIPCTopologyWatcher

public AFTIPCTopologyWatcher(int defaultTimeoutSeconds)
                      throws IOException

Creates an AFTIPCTopologyWatcher whose subscription requests use the given default timeout.

Parameters:

defaultTimeoutSeconds - The timeout in seconds (or AFTIPCTopologySubscription.TIPC_WAIT_FOREVER;

Throws:

IOException - on error.

Method Details

finalize

@Deprecated
protected final void finalize()

Deprecated.

Overrides:

finalize in class Object

addPortSubscription

public final AFTIPCTopologySubscription addPortSubscription()
                                                     throws IOException

Watches for all port changes.

Returns:

The subscription object.

Throws:

IOException - on error.

See Also:

• cancelSubscription(AFTIPCTopologySubscription)

addPortSubscription

public final AFTIPCTopologySubscription addPortSubscription(int port)
                                                     throws IOException

Watches for port changes of the given port ("port" meaning TIPC port, not TCP).

Parameters:

port - The port.

Returns:

The subscription object.

Throws:

IOException - on error.

See Also:

• cancelSubscription(AFTIPCTopologySubscription)

addPortSubscription

public final AFTIPCTopologySubscription addPortSubscription(int lower,
 int upper)
                                                     throws IOException

Watches for port changes within the given range ("port" meaning TIPC port, not TCP).

Parameters:

lower - The lower value of the port range.

upper - The upper value of the port range.

Returns:

The subscription object.

Throws:

IOException - on error.

See Also:

• cancelSubscription(AFTIPCTopologySubscription)

addLinkStateSubscription

public final AFTIPCTopologySubscription addLinkStateSubscription()
                                                          throws IOException

Watches for all link state changes.

Returns:

The subscription object.

Throws:

IOException - on error.

See Also:

• cancelSubscription(AFTIPCTopologySubscription)

addServiceSubscription

public final AFTIPCTopologySubscription addServiceSubscription(int type)
                                                        throws IOException

Watches for service changes of the given service type, matching any instance.

Parameters:

type - The service type.

Returns:

The subscription object.

Throws:

IOException - on error.

See Also:

• cancelSubscription(AFTIPCTopologySubscription)

addServiceSubscription

public final AFTIPCTopologySubscription addServiceSubscription(int type,
 int instance)
                                                        throws IOException

Watches for service changes of the given service type, matching only the specified instance.

Parameters:

type - The service type.

instance - The instance to match.

Returns:

The subscription object.

Throws:

IOException - on error.

See Also:

• cancelSubscription(AFTIPCTopologySubscription)

addServiceSubscription

public final AFTIPCTopologySubscription addServiceSubscription(int type,
 int lower,
 int upper)
                                                        throws IOException

Watches for service changes of the given service type and instance range.

Parameters:

type - The service type.

lower - The lower value of the instance range.

upper - The upper value of the instance range.

Returns:

The subscription object.

Throws:

IOException - on error.

See Also:

• cancelSubscription(AFTIPCTopologySubscription)

cancelSubscription

public final void cancelSubscription(AFTIPCTopologySubscription sub)
                              throws IOException

Cancels a previously added service subscription.

Parameters:

sub - The subscription to cancel.

Throws:

IOException - on error.

sendMessage

public final AFTIPCTopologySubscription sendMessage(AFTIPCTopologySubscription sub)
                                             throws IOException

Sends a manually crafted subscription message to the TIPC topology server. You usually don't need to do this directly; use the #addPortSubscription(int, int)/cancelSubscription(AFTIPCTopologySubscription) methods instead.

Parameters:

sub - The subscription message.

Returns:

The very message.

Throws:

IOException - on error.

runLoop

public final void runLoop()
                   throws IOException

Runs a receive loop until stopLoop() or close() is called. This method returns after the run loop terminates.

Throws:

IOException - on error.

onEvent

protected void onEvent(AFTIPCTopologyEvent event)
                throws IOException

Called for every event encountered by the run loop.

Parameters:

event - The event.

Throws:

IOException - on error. Any exception will terminate the run loop.

See Also:

• runLoop()

onClose

protected void onClose()
                throws IOException

Called upon close().

Throws:

IOException - on error.

isRunning

public boolean isRunning()

Checks if the watcher run loop is running.

Returns:

true if running.

See Also:

• runLoop()

stopLoop

public final void stopLoop()

Stops the run loop.

close

public final void close()
                 throws IOException

Closes this instance.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException