Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
PollingConsumer |
|
| 0.0;0 |
1 | /** |
|
2 | * Licensed to the Apache Software Foundation (ASF) under one or more |
|
3 | * contributor license agreements. See the NOTICE file distributed with |
|
4 | * this work for additional information regarding copyright ownership. |
|
5 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
|
6 | * (the "License"); you may not use this file except in compliance with |
|
7 | * the License. You may obtain a copy of the License at |
|
8 | * |
|
9 | * http://www.apache.org/licenses/LICENSE-2.0 |
|
10 | * |
|
11 | * Unless required by applicable law or agreed to in writing, software |
|
12 | * distributed under the License is distributed on an "AS IS" BASIS, |
|
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
14 | * See the License for the specific language governing permissions and |
|
15 | * limitations under the License. |
|
16 | */ |
|
17 | package org.apache.camel; |
|
18 | ||
19 | /** |
|
20 | * Represents a <a |
|
21 | * href="http://activemq.apache.org/camel/polling-consumer.html">Polling |
|
22 | * Consumer</a> where the caller polls for messages when it is ready. |
|
23 | * |
|
24 | * @version $Revision: 1.1 $ |
|
25 | */ |
|
26 | public interface PollingConsumer<E extends Exchange> extends Consumer<E> { |
|
27 | ||
28 | /** |
|
29 | * Waits until a message is available and then returns it. Warning that this |
|
30 | * method could block indefinitely if no messages are available. |
|
31 | * |
|
32 | * @return the message exchange received. |
|
33 | */ |
|
34 | E receive(); |
|
35 | ||
36 | /** |
|
37 | * Attempts to receive a message exchange immediately without waiting and |
|
38 | * returning null if a message exchange is not available yet. |
|
39 | * |
|
40 | * @return the message exchange if one is immediately available otherwise |
|
41 | * null |
|
42 | */ |
|
43 | E receiveNoWait(); |
|
44 | ||
45 | /** |
|
46 | * Attempts to receive a message exchange, waiting up to the given timeout |
|
47 | * to expire if a message is not yet available |
|
48 | * |
|
49 | * @param timeout the amount of time in milliseconds to wait for a message |
|
50 | * before timing out and returning null |
|
51 | * |
|
52 | * @return the message exchange if one iwas available within the timeout |
|
53 | * period, or null if the timeout expired |
|
54 | */ |
|
55 | E receive(long timeout); |
|
56 | ||
57 | } |