diff options
Diffstat (limited to 'src/main/java/org/onap/dmaap/mr/client/MRBatchingPublisher.java')
| -rw-r--r-- | src/main/java/org/onap/dmaap/mr/client/MRBatchingPublisher.java | 47 |
1 files changed, 25 insertions, 22 deletions
diff --git a/src/main/java/org/onap/dmaap/mr/client/MRBatchingPublisher.java b/src/main/java/org/onap/dmaap/mr/client/MRBatchingPublisher.java index df440bb..0ee5a0b 100644 --- a/src/main/java/org/onap/dmaap/mr/client/MRBatchingPublisher.java +++ b/src/main/java/org/onap/dmaap/mr/client/MRBatchingPublisher.java @@ -4,11 +4,13 @@ * ================================================================================ * Copyright © 2017 AT&T Intellectual Property. All rights reserved. * ================================================================================ + * Modifications Copyright © 2021 Orange. + * ================================================================================ * Licensed 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. @@ -17,8 +19,9 @@ * ============LICENSE_END========================================================= * * ECOMP is a trademark and service mark of AT&T Intellectual Property. - * + * *******************************************************************************/ + package org.onap.dmaap.mr.client; import java.io.IOException; @@ -29,27 +32,27 @@ import org.onap.dmaap.mr.client.response.MRPublisherResponse; /** * A MR batching publisher is a publisher with additional functionality * for managing delayed sends. - * - * @author author * + * @author author */ -public interface MRBatchingPublisher extends MRPublisher -{ - /** - * Get the number of messages that have not yet been sent. - * @return the number of pending messages - */ - int getPendingMessageCount (); +public interface MRBatchingPublisher extends MRPublisher { + /** + * Get the number of messages that have not yet been sent. + * + * @return the number of pending messages + */ + int getPendingMessageCount(); + + /** + * Close this publisher, sending any remaining messages. + * + * @param timeout an amount of time to wait for unsent messages to be sent + * @param timeoutUnits the time unit for the timeout arg + * @return a list of any unsent messages after the timeout + * @throws IOException exception + * @throws InterruptedException exception + */ + List<Message> close(long timeout, TimeUnit timeoutUnits) throws IOException, InterruptedException; - /** - * Close this publisher, sending any remaining messages. - * @param timeout an amount of time to wait for unsent messages to be sent - * @param timeoutUnits the time unit for the timeout arg - * @return a list of any unsent messages after the timeout - * @throws IOException exception - * @throws InterruptedException exception - */ - List<message> close ( long timeout, TimeUnit timeoutUnits ) throws IOException, InterruptedException; - - MRPublisherResponse sendBatchWithResponse (); + MRPublisherResponse sendBatchWithResponse(); } |