Class AFTIPCTopologySubscription

java.lang.Object

org.newsclub.net.unix.tipc.AFTIPCTopologySubscription

@NonNullByDefault
public final class AFTIPCTopologySubscription
extends Object

An "event subscription" to be used with AFTIPCTopologyWatcher.

Author:

Christian Kohlschütter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AFTIPCTopologySubscription.Flags	Some flags used in the subscription request.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TIPC_LINK_STATE	The "link state" cluster connectivity monitor mode.
static final int	TIPC_NODE_STATE	The "node state" cluster topology monitor mode.
static final int	TIPC_WAIT_FOREVER	Special timeout value meaning "never timeout".

Constructor Summary

Constructors

Constructor	Description
AFTIPCTopologySubscription(int type, int lower, int upper, AFTIPCTopologySubscription.Flags flags)	Creates a new subscription message that does not time out.
AFTIPCTopologySubscription(int type, int lower, int upper, AFTIPCTopologySubscription.Flags flags, int timeoutSeconds)	Creates a new subscription message.
AFTIPCTopologySubscription(int type, int lower, int upper, AFTIPCTopologySubscription.Flags flags, int timeoutSeconds, byte[] usrHandle)	Creates a new subscription message.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
AFTIPCTopologySubscription.Flags	getFlags()	Returns the flags.
int	getLower()	Returns the lower instance value.
int	getTimeout()	Returns the timeout, in seconds (or TIPC_WAIT_FOREVER for "never timeout").
int	getType()	Returns the service type.
int	getUpper()	Returns the upper instance value.
byte[]	getUsrHandle()	Returns the 8-byte user handle.
int	hashCode()
boolean	isCancellation()	Returns true iff the subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_CANCEL flag set.
boolean	isPort()	Returns true iff the subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_PORTS flag set.
boolean	isService()	Returns true iff the subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_SERVICE flag set.
ByteBuffer	toBuffer()	Converts this subscription message to a new ByteBuffer.
AFTIPCTopologySubscription	toCancellation()	Creates an AFTIPCTopologySubscription that cancels this subscription.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TIPC_WAIT_FOREVER

public static final int TIPC_WAIT_FOREVER

Special timeout value meaning "never timeout".

See Also:

• Constant Field Values

TIPC_NODE_STATE

public static final int TIPC_NODE_STATE

The "node state" cluster topology monitor mode. When TIPC establishes contact with another node, it does internally create a binding {type = TIPC_NODE_STATE, instance = peer node hash number} in the binding table. This makes it possible for applications on a node to keep track of reachable peer nodes at any time. *

See Also:

• Constant Field Values

TIPC_LINK_STATE

public static final int TIPC_LINK_STATE

The "link state" cluster connectivity monitor mode. When TIPC establishes a new link to another node, it does internally create a binding {type = TIPC_LINK_STATE, instance = peer node hash number} in the binding table. This makes it possible for applications on a node to keep track of working links to peer nodes at any time. This type of binding differs from the topology subscription binding (TIPC_NODE_STATE) in that there may be two links, and hence two bindings, to keep track of for each peer node. Although this binding type only is published with node visibility, it is possible to combine it with remote node topology subscriptions to obtain a full and continuous matrix view of the connectivity in the cluster.

See Also:

• Constant Field Values

Constructor Details

AFTIPCTopologySubscription

public AFTIPCTopologySubscription(int type,
 int lower,
 int upper,
 AFTIPCTopologySubscription.Flags flags)

Creates a new subscription message that does not time out.

Parameters:

type - The service type (any service, particularly TIPC_NODE_STATE and TIPC_LINK_STATE.

lower - The lower instance.

upper - The upper instance.

flags - Any flaas (use AFTIPCTopologySubscription.Flags.NONE if you don't have any).

AFTIPCTopologySubscription

public AFTIPCTopologySubscription(int type,
 int lower,
 int upper,
 AFTIPCTopologySubscription.Flags flags,
 int timeoutSeconds)

Creates a new subscription message.

Parameters:

type - The service type (any service, particularly TIPC_NODE_STATE and TIPC_LINK_STATE.

lower - The lower instance.

upper - The upper instance.

flags - Any flaas (use AFTIPCTopologySubscription.Flags.NONE if you don't have any).

timeoutSeconds - The timeout (in seconds), or -1 if this should never time out.

AFTIPCTopologySubscription

public AFTIPCTopologySubscription(int type,
 int lower,
 int upper,
 AFTIPCTopologySubscription.Flags flags,
 int timeoutSeconds,
 byte[] usrHandle)

Creates a new subscription message.

Parameters:

type - The service type (any service, particularly TIPC_NODE_STATE and TIPC_LINK_STATE.

lower - The lower instance.

upper - The upper instance.

flags - Any flaas (use AFTIPCTopologySubscription.Flags.NONE if you don't have any).

timeoutSeconds - The timeout (in seconds), or -1 if this should never time out.

usrHandle - A custom 8-byte message that is included in AFTIPCTopologyEvent messages.

Method Details

toBuffer

public ByteBuffer toBuffer()

Converts this subscription message to a new ByteBuffer.

Returns:

The new buffer, ready to read from.

toString

public String toString()

Overrides:

toString in class Object

toCancellation

public AFTIPCTopologySubscription toCancellation()

Creates an AFTIPCTopologySubscription that cancels this subscription. Note that a cancellation cannot be cancelled again.

Returns:

The new AFTIPCTopologySubscription.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

getType

public int getType()

Returns the service type.

Returns:

The type.

getLower

public int getLower()

Returns the lower instance value.

Returns:

The lower instance value.

getUpper

public int getUpper()

Returns the upper instance value.

Returns:

The upper instance value.

getFlags

public AFTIPCTopologySubscription.Flags getFlags()

Returns the flags.

Returns:

The flags.

getTimeout

public int getTimeout()

Returns the timeout, in seconds (or TIPC_WAIT_FOREVER for "never timeout").

Returns:

The timeout.

getUsrHandle

public byte[] getUsrHandle()

Returns the 8-byte user handle.

Returns:

The user handle.

isPort

public boolean isPort()

Returns true iff the subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_PORTS flag set.

Returns:

true if this is a "port" subscription.

isService

public boolean isService()

Returns true iff the subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_SERVICE flag set.

Returns:

true if this is a "service" subscription.

isCancellation

public boolean isCancellation()

Returns true iff the subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_CANCEL flag set.

Returns:

true if this is a "cancellation" subscription request.