src/main/java/com/att/dmf/mr/metrics/publisher/CambriaBatchingPublisher.java

   1 /*******************************************************************************
   2  *  ============LICENSE_START=======================================================
   3  *  org.onap.dmaap
   4  *  ================================================================================
   5  *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  *  ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  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  *  ============LICENSE_END=========================================================
  18  *
  19  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20  *
  21  *******************************************************************************/
  22 package com.att.dmf.mr.metrics.publisher;
  23
  24 import java.io.IOException;
  25 import java.util.List;
  26 import java.util.concurrent.TimeUnit;
  27
  28 /**
  29  * A Cambria batching publisher is a publisher with additional functionality
  30  * for managing delayed sends.
  31  *
  32  * @author peter
  33  *
  34  */
  35 public interface CambriaBatchingPublisher extends CambriaPublisher
  36 {
  37         /**
  38          * Get the number of messages that have not yet been sent.
  39          * @return the number of pending messages
  40          */
  41         int getPendingMessageCount ();
  42
  43         /**
  44          * Close this publisher, sending any remaining messages.
  45          * @param timeout an amount of time to wait for unsent messages to be sent
  46          * @param timeoutUnits the time unit for the timeout arg
  47          * @return a list of any unsent messages after the timeout
  48          * @throws IOException
  49          * @throws InterruptedException
  50          */
  51         List<message> close ( long timeout, TimeUnit timeoutUnits ) throws IOException, InterruptedException;
  52 }