IBrowser Interface

Solclient

IBrowser Interface

version: 7.2.1.27

A Browser allows client applications to look at messages spooled on Endpoints without removing them. Messages are browsed from oldest to newest. After being browsed, messages are still available for consumption over normal flows. However, it is possible to selectively remove messages from the persistent store of an Endpoint, in this case, these removed messages will no longer be available for consumption. One typical application is to use browsers to allow message bus administrators to remove “stuck” Guaranteed messages from an endpoint without having to modify or disrupt existing applications. A message can get stuck if: It hass been received by an application, but for some reason, that application has failed to acknowledge it. All active message selectors have failed to match this particular message and therefore the message bus has not delivered it to any client yet. The current release only supports browsing Endpoints of type Queue. Note that the delivery restrictions imposed by the queue’s Access type (exclusive or non-exclusive), do not apply when browsing messages with a Browser.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

public interface IBrowser : IDisposable

Public Interface IBrowser
	Inherits IDisposable

public interface class IBrowser : IDisposable

The IBrowser type exposes the following members.

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	GetNext	If there is at least one message available in the Browser’s local message buffer, return it immediately. Otherwise wait up to WaitTimeout(in BrowserProperties) until one is available.
	GetNext(Int32)	If there is at least one message available in the Browser’s local message buffer, return it immediately. Otherwise wait up to WaitTimeout(as specified in BrowserProperties) until one is available. - If timeout is < 0, return immediately if there are no messages available locally - If timeout is equal to 0, wait forever. This blocks the calling thread; to unblock it, call Dispose.
	GetNextNoWait	As the name implies, this method returns a message if there is at least one available in the Browser's local buffer; otherwise, it returns null.
	HasMore	Returns true if there is at least one message available in the Browser's local message buffer. Note: If this method returns false, it does not mean that the queue is empty; subsequent calls to HasMore or GetNext might return true and a IMessage respectively.
	Remove(Int64)	Remove a message from the appliance queue endpoint that this Browser is bound to, given its ADMessageId.
	Remove(IMessage)	Remove a message from the appliance queue endpoint that this Browser is bound to, given its IMessage reference.

Top

Reference

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page