APIdia Launch Partner
Top Description Methods
com.sun.jmx.remote.internal

public Interface NotificationBuffer

Known Direct Implementers
com.sun.jmx.remote.internal.ArrayNotificationBuffer, com.sun.jmx.remote.internal.ArrayNotificationBuffer.ShareBuffer
Imports
java.util.Set, javax.management.remote.NotificationResult, .TargetedNotification

A buffer of notifications received from an MBean server.

Method Summary

Modifier and TypeMethod and Description
public void
dispose()

Discard this buffer.

public NotificationResult
fetchNotifications(NotificationBufferFilter
an object that will add notifications to a List<TargetedNotification> if they match the current listeners with their filters.
filter
,
long
the first sequence number to consider.
startSequenceNumber
,
long
the maximum time to wait. May be 0 to indicate not to wait if there are no notifications.
timeout
,
int
the maximum number of notifications to return. May be 0 to indicate a wait for eligible notifications that will return a usable nextSequenceNumber. The TargetedNotification array in the returned NotificationResult may contain more than this number of elements but will not contain more than this number of different notifications.
maxNotifications
)

Fetch notifications that match the given listeners.

Method Detail

disposeback to summary
public void dispose()

Discard this buffer.

fetchNotificationsback to summary
public NotificationResult fetchNotifications(NotificationBufferFilter filter, long startSequenceNumber, long timeout, int maxNotifications) throws InterruptedException

Fetch notifications that match the given listeners.

The operation only considers notifications with a sequence number at least startSequenceNumber. It will take no longer than timeout, and will return no more than maxNotifications different notifications.

If there are no notifications matching the criteria, the operation will block until one arrives, subject to the timeout.

Parameters
filter:NotificationBufferFilter

an object that will add notifications to a List<TargetedNotification> if they match the current listeners with their filters.

startSequenceNumber:long

the first sequence number to consider.

timeout:long

the maximum time to wait. May be 0 to indicate not to wait if there are no notifications.

maxNotifications:int

the maximum number of notifications to return. May be 0 to indicate a wait for eligible notifications that will return a usable nextSequenceNumber. The TargetedNotification array in the returned NotificationResult may contain more than this number of elements but will not contain more than this number of different notifications.