1 /*
2  * librdkafka - Apache Kafka C library
3  *
4  * Copyright (c) 2012,2013 Magnus Edenhill
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  *    this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  *    this list of conditions and the following disclaimer in the documentation
14  *    and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef _RDKAFKA_OFFSET_H_
30 #define _RDKAFKA_OFFSET_H_
31 
32 #include "rdkafka_partition.h"
33 
34 
35 const char *rd_kafka_offset2str (int64_t offset);
36 
37 
38 /**
39  * Stores the offset for the toppar 'rktp'.
40  * The actual commit of the offset to backing store is usually
41  * performed at a later time (time or threshold based).
42  *
43  * See head of rdkafka_offset.c for more information.
44  */
45 static RD_INLINE RD_UNUSED
rd_kafka_offset_store0(rd_kafka_toppar_t * rktp,int64_t offset,int lock)46 void rd_kafka_offset_store0 (rd_kafka_toppar_t *rktp, int64_t offset,
47 			     int lock) {
48 	if (lock)
49 		rd_kafka_toppar_lock(rktp);
50 	rktp->rktp_stored_offset = offset;
51 	if (lock)
52 		rd_kafka_toppar_unlock(rktp);
53 }
54 
55 rd_kafka_resp_err_t rd_kafka_offset_store (rd_kafka_topic_t *rkt,
56 					   int32_t partition, int64_t offset);
57 
58 rd_kafka_resp_err_t rd_kafka_offset_sync (rd_kafka_toppar_t *rktp);
59 
60 void rd_kafka_offset_store_term (rd_kafka_toppar_t *rktp,
61                                  rd_kafka_resp_err_t err);
62 rd_kafka_resp_err_t rd_kafka_offset_store_stop (rd_kafka_toppar_t *rktp);
63 void rd_kafka_offset_store_init (rd_kafka_toppar_t *rktp);
64 
65 void rd_kafka_offset_reset (rd_kafka_toppar_t *rktp, int64_t err_offset,
66 			    rd_kafka_resp_err_t err, const char *reason);
67 
68 void rd_kafka_offset_query_tmr_cb (rd_kafka_timers_t *rkts, void *arg);
69 
70 #endif /* _RDKAFKA_OFFSET_H_ */
71