/
relay.h
130 lines (114 loc) · 3.43 KB
/
relay.h
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
#ifndef TARANTOOL_REPLICATION_RELAY_H_INCLUDED
#define TARANTOOL_REPLICATION_RELAY_H_INCLUDED
/*
* Copyright 2010-2016, Tarantool AUTHORS, please see AUTHORS file.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* 1. Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <stdint.h>
#if defined(__cplusplus)
extern "C" {
#endif /* defined(__cplusplus) */
struct relay;
struct replica;
struct tt_uuid;
struct vclock;
enum relay_state {
/**
* Applier has not connected to the master or not expected.
*/
RELAY_OFF,
/**
* Applier has connected to the master.
*/
RELAY_FOLLOW,
/**
* Applier disconnected from the master.
*/
RELAY_STOPPED,
};
/** Create a relay which is not running. object. */
struct relay *
relay_new(struct replica *replica);
/** Cancel a running relay. Called on shutdown. */
void
relay_cancel(struct relay *relay);
/** Destroy and delete the relay */
void
relay_delete(struct relay *relay);
/** Get last relay's diagnostic error */
struct diag*
relay_get_diag(struct relay *relay);
/** Return the current state of relay. */
enum relay_state
relay_get_state(const struct relay *relay);
/**
* Returns relay's vclock
* @param relay relay
* @returns relay's vclock
*/
const struct vclock *
relay_vclock(const struct relay *relay);
/**
* Returns relay's last_row_time
* @param relay relay
* @returns relay's last_row_time
*/
double
relay_last_row_time(const struct relay *relay);
#if defined(__cplusplus)
} /* extern "C" */
#endif /* defined(__cplusplus) */
/**
* Send initial JOIN rows to the replica
*
* @param fd client connection
* @param sync sync from incoming JOIN request
* @param vclock vclock of the last checkpoint
*/
void
relay_initial_join(int fd, uint64_t sync, struct vclock *vclock);
/**
* Send final JOIN rows to the replica.
*
* @param fd client connection
* @param sync sync from incoming JOIN request
*/
void
relay_final_join(int fd, uint64_t sync, struct vclock *start_vclock,
struct vclock *stop_vclock);
/**
* Subscribe a replica to updates.
*
* @return none.
*/
void
relay_subscribe(struct replica *replica, int fd, uint64_t sync,
struct vclock *replica_vclock, uint32_t replica_version_id,
uint32_t replica_id_filter);
#endif /* TARANTOOL_REPLICATION_RELAY_H_INCLUDED */