/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Apache.NMS
{
///
/// A delegate that can receive messages async.
///
public delegate void MessageListener(IMessage message);
///
/// A consumer of messages
///
public interface IMessageConsumer : System.IDisposable
{
///
/// Waits until a message is available and returns it
///
IMessage Receive();
///
/// If a message is available within the timeout duration it is returned otherwise this method returns null
///
IMessage Receive(System.TimeSpan timeout);
///
/// If a message is available immediately it is returned otherwise this method returns null
///
IMessage ReceiveNoWait();
///
/// An asynchronous listener which can be used to consume messages asynchronously
///
event MessageListener Listener;
///
/// Closes the message consumer.
///
///
/// Clients should close message consumers them when they are not needed.
/// This call blocks until a receive or message listener in progress has completed.
/// A blocked message consumer receive call returns null when this message consumer is closed.
///
void Close();
}
}