Module org.newsclub.net.unix.tipc

Package org.newsclub.net.unix.tipc

Class AFTIPCTopologyEvent

java.lang.Object

org.newsclub.net.unix.tipc.AFTIPCTopologyEvent

@NonNullByDefault
public final class AFTIPCTopologyEvent
extends Object

A TIPC topology event received by the AFTIPCTopologyWatcher as a result of an AFTIPCTopologySubscription.

Author:

Christian Kohlschütter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AFTIPCTopologyEvent.Type	Some TIPC error code.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
AFTIPCSocketAddress	getAddress()	The corresponding socket address.
int	getFoundLower()	The found range's lower value.
int	getFoundUpper()	The found range's upper value.
@Nullable String	getLinkName()	Returns the link name for a link state event requested by AFTIPCTopologySubscription.TIPC_LINK_STATE or AFTIPCTopologyWatcher.addLinkStateSubscription().
AFTIPCTopologySubscription	getSubscription()	The corresponding subscription that found this event.
AFTIPCTopologyEvent.Type	getType()	The event type.
int	hashCode()
boolean	isCancellationRequest()	Returns true iff the corresponding subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_CANCEL flag set.
boolean	isPort()	Returns true iff the corresponding subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_PORTS flag set.
boolean	isPublished()	Returns true iff the event type is AFTIPCTopologyEvent.Type.TIPC_PUBLISHED.
boolean	isService()	Returns true iff the corresponding subscription has the AFTIPCTopologySubscription.Flags.TIPC_SUB_SERVICE flag set.
boolean	isTimeout()	Returns true iff the event type is AFTIPCTopologyEvent.Type.TIPC_SUBSCR_TIMEOUT.
boolean	isWithdrawn()	Returns true iff the event type is AFTIPCTopologyEvent.Type.TIPC_WITHDRAWN.
ByteBuffer	toBuffer()	Converts this event message to a new ByteBuffer.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

toBuffer

public ByteBuffer toBuffer()
                    throws IOException

Converts this event message to a new ByteBuffer.

Returns:

The new buffer, ready to read from.

Throws:

IOException - on error.

getType

public AFTIPCTopologyEvent.Type getType()

The event type.

Returns:

The type.

getFoundLower

public int getFoundLower()

The found range's lower value.

Returns:

The lower value.

getFoundUpper

public int getFoundUpper()

The found range's upper value.

Returns:

The upper value.

getAddress

public AFTIPCSocketAddress getAddress()

The corresponding socket address.

Returns:

The socket address.

getSubscription

public AFTIPCTopologySubscription getSubscription()

The corresponding subscription that found this event.

Returns:

The subscription.

isPublished

public boolean isPublished()

Returns true iff the event type is AFTIPCTopologyEvent.Type.TIPC_PUBLISHED.

Returns:

true if this a "published" event.

isWithdrawn

public boolean isWithdrawn()

Returns true iff the event type is AFTIPCTopologyEvent.Type.TIPC_WITHDRAWN.

Returns:

true if this a "withdrawn" event.

isTimeout

public boolean isTimeout()

Returns true iff the event type is AFTIPCTopologyEvent.Type.TIPC_SUBSCR_TIMEOUT.

Returns:

true if this a "timeout" event.

isPort

public boolean isPort()

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

Returns:

true if this a event referring to a "port" subscription.

isService

public boolean isService()

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

Returns:

true if this a event referring to a "service" subscription.

isCancellationRequest

public boolean isCancellationRequest()

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

Returns:

true if this a event referring to a "cancellation" subscription request.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

getLinkName

public @Nullable String getLinkName()
                             throws IOException

Returns the link name for a link state event requested by AFTIPCTopologySubscription.TIPC_LINK_STATE or AFTIPCTopologyWatcher.addLinkStateSubscription(). A link name is something like "f875a40e707d:eth0-8c1645f2ce27:eth0"

Returns:

The link name, or null if unsupported.

Throws:

IOException - on error.