blob: 8196a0a56f25340f641fde42797dfa9f0c39457f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
/*******************************************************************************
* ============LICENSE_START=======================================================
* org.onap.dmaap
* ================================================================================
* 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.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*
*******************************************************************************/
package org.onap.dmaap.mr.client;
import java.io.IOException;
import org.onap.dmaap.mr.client.response.MRConsumerResponse;
public interface MRConsumer extends MRClient {
/**
* Fetch a set of messages. The consumer's timeout and message limit are used if set in the constructor call.
*
* @return a set of messages
* @throws IOException
*/
Iterable<String> fetch() throws IOException, Exception;
/**
* Fetch a set of messages with an explicit timeout and limit for this call. These values
* override any set in the constructor call.
*
* @param timeoutMs The amount of time in milliseconds that the server should keep the connection
* open while waiting for message traffic. Use -1 for default timeout (controlled on the server-side).
* @param limit A limit on the number of messages returned in a single call. Use -1 for no limit.
* @return a set messages
* @throws IOException if there's a problem connecting to the server
*/
Iterable<String> fetch(int timeoutMs, int limit) throws IOException, Exception;
MRConsumerResponse fetchWithReturnConsumerResponse();
MRConsumerResponse fetchWithReturnConsumerResponse(int timeoutMs, int limit);
}
|
