COM.activesw.api.client

Interface BrokerLockedQueueBrowser

All Superinterfaces:

BrokerQueueBrowser

All Known Implementing Classes:

BrokerLockedClientQueueBrowser, BrokerLockedForwardQueueBrowser

public interface BrokerLockedQueueBrowser
extends BrokerQueueBrowser

Method Summary

Modifier and Type	Method and Description
int	deleteEvents(long[] seqns) Delete events in the queue.
void	insertEventsAtHead(BrokerEvent[] events) Insert events in into the queue.
void	insertEventsAtTail(BrokerEvent[] events) Insert events in into the queue.
void	modifyEvents(long[] seqns, BrokerEvent[] events) Modify events in the queue.

Methods inherited from interface COM.activesw.api.client.BrokerQueueBrowser

browseEvents, closeQueueBrowser, getBrowserInfo, getFilters, resetFilters, setFilter, setFilters, setPosition

Method Detail

modifyEvents

void modifyEvents(long[] seqns,
                  BrokerEvent[] events)
           throws BrokerException

Modify events in the queue. The events are identified by the specified receipt sequence numbers for an in-place update in the queue.

Parameters:

seqns - An array of sequence numbers that identify the events to be modified in the queue.

events - An array of BrokerEvent that will be updated in place of the events in the queue.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerQueueBrowserException - If the event cannot be modified

BrokerException

deleteEvents

int deleteEvents(long[] seqns)
          throws BrokerException

Delete events in the queue. The events are identified by their receipt sequence numbers.

Parameters:

seqns - An array of sequence numbers that identify the events in the queue.

Returns:

The number of events deleted from the queue.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerQueueBrowserException - If the event cannot be deleted

BrokerException

insertEventsAtHead

void insertEventsAtHead(BrokerEvent[] events)
                 throws BrokerException

Insert events in into the queue. The specified events will be inserted at the head of the queue.

Parameters:

events - An array of events to be inserted.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerQueueBrowserException - If the event cannot be inserted

BrokerException

insertEventsAtTail

void insertEventsAtTail(BrokerEvent[] events)
                 throws BrokerException

Insert events in into the queue. The specified events will be inserted at the end of the queue.

Parameters:

events - An array of events to be inserted.

Throws:

BrokerInvalidClientException - If the client has been destroyed or disconnected.

BrokerQueueBrowserException - If the event cannot be inserted

BrokerException