Coverage Report - org.apache.camel.PollingConsumer
 
Classes in this File Line Coverage Branch Coverage Complexity
PollingConsumer
N/A 
N/A 
0
 
 1  
 /**
 2  
  *
 3  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 4  
  * contributor license agreements.  See the NOTICE file distributed with
 5  
  * this work for additional information regarding copyright ownership.
 6  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 7  
  * (the "License"); you may not use this file except in compliance with
 8  
  * the License.  You may obtain a copy of the License at
 9  
  *
 10  
  * http://www.apache.org/licenses/LICENSE-2.0
 11  
  *
 12  
  * Unless required by applicable law or agreed to in writing, software
 13  
  * distributed under the License is distributed on an "AS IS" BASIS,
 14  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15  
  * See the License for the specific language governing permissions and
 16  
  * limitations under the License.
 17  
  */
 18  
 package org.apache.camel;
 19  
 
 20  
 /**
 21  
  * Represents a <a href="http://activemq.apache.org/camel/polling-consumer.html">Polling Consumer</a> where the caller
 22  
  * 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 method
 30  
      * 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
 38  
      * and returning null if a message exchange is not available yet.
 39  
      *
 40  
      * @return the message exchange if one is immediately available otherwise null
 41  
      */
 42  
     E receiveNoWait();
 43  
 
 44  
     /**
 45  
      * Attempts to receive a message exchange, waiting up to the given timeout to expire
 46  
      * if a message is not yet available
 47  
      *
 48  
      * @param timeout the amount of time in milliseconds to wait for a message before timing out and
 49  
      * returning null
 50  
      *
 51  
      * @return the message exchange if one iwas available within the timeout period, or null if the timeout expired
 52  
      */
 53  
     E receive(long timeout);
 54  
 
 55  
 }