Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
ruanhaishen
Willemt Raft
Commits
01102556
Commit
01102556
authored
Jan 19, 2014
by
willem
Browse files
Refining comments
parent
e595ff7e
Changes
1
Show whitespace changes
Inline
Side-by-side
include/raft.h
View file @
01102556
...
...
@@ -155,16 +155,16 @@ typedef struct {
}
raft_entry_t
;
/**
* Initialise a new
r
aft server
* Initialise a new
R
aft server
*
* Request timeout defaults to 200 milliseconds
* Election timeout defaults to 1000 milliseconds
*
* @return newly initialised
r
aft server */
* @return newly initialised
R
aft server */
raft_server_t
*
raft_new
();
/**
* De-Initialise
r
aft server
* De-Initialise
R
aft server
* Free all memory */
void
raft_free
(
raft_server_t
*
me_
);
...
...
@@ -176,29 +176,32 @@ void raft_set_callbacks(raft_server_t* me, raft_cbs_t* funcs, void* cb_ctx);
/**
* Set configuration
* @param nodes Array of nodes
, e
nd of array is marked by NULL entry
* @param my_idx
Which node is myself
*/
* @param nodes Array of nodes
. E
nd of array is marked by NULL entry
* @param my_idx
Index of the node that refers to this Raft server
*/
void
raft_set_configuration
(
raft_server_t
*
me_
,
raft_node_configuration_t
*
nodes
,
int
my_idx
);
/**
* Set election timeout
* @param millisec Election timeout in milliseconds */
void
raft_set_election_timeout
(
raft_server_t
*
me
,
int
millisec
);
* The amount of time that needs to elapse before we assume the leader is down
* @param msec Election timeout in milliseconds */
void
raft_set_election_timeout
(
raft_server_t
*
me
,
int
msec
);
/**
* Set request timeout in milliseconds
* @param millisec Request timeout in milliseconds */
void
raft_set_request_timeout
(
raft_server_t
*
me_
,
int
millisec
);
* The amount of time before we resend an appendentries message
* @param msec Request timeout in milliseconds */
void
raft_set_request_timeout
(
raft_server_t
*
me_
,
int
msec
);
/**
* Run actions that are dependent on time passing
* Process events that are dependent on time passing
* @param msec_elapsed Time in milliseconds since the last raft_periodic() call
* @return 0 on error */
int
raft_periodic
(
raft_server_t
*
me
,
int
msec_
since_last_perio
d
);
int
raft_periodic
(
raft_server_t
*
me
,
int
msec_
elapse
d
);
/**
* Receive an appendentries message
* @param node
W
ho sent us th
e response
* @param node
Index of the node w
ho sent us th
is message
* @param ae The appendentries message
* @return 0 on error */
int
raft_recv_appendentries
(
raft_server_t
*
me
,
int
node
,
...
...
@@ -206,14 +209,14 @@ int raft_recv_appendentries(raft_server_t* me, int node,
/**
* Receive a response from an appendentries message we sent
* @param node
W
ho sent us th
e response
* @param r The appendentries response
* @param node
Index of the node w
ho sent us th
is message
* @param r The appendentries response
message
* @return 0 on error */
int
raft_recv_appendentries_response
(
raft_server_t
*
me_
,
int
node
,
msg_appendentries_response_t
*
r
);
/**
* Receive a requestvote message
* @param node
W
ho sent us th
e
message
* @param node
Index of the node w
ho sent us th
is
message
* @param vr The requestvote message
* @return 0 on error */
int
raft_recv_requestvote
(
raft_server_t
*
me
,
int
node
,
...
...
@@ -221,8 +224,8 @@ int raft_recv_requestvote(raft_server_t* me, int node,
/**
* Receive a response from a requestvote message we sent
* @param node
W
ho sent us th
e response
* @param r The requestvote response
* @param node
Index of the node w
ho sent us th
is message
* @param r The requestvote response
message
* @param node The node this response was sent by */
int
raft_recv_requestvote_response
(
raft_server_t
*
me
,
int
node
,
msg_requestvote_response_t
*
r
);
...
...
@@ -231,7 +234,7 @@ int raft_recv_requestvote_response(raft_server_t* me, int node,
* Receive an entry message from client.
* Append the entry to the log
* Send appendentries to followers
* @param node
The node
this
r
es
ponse was sent by
* @param node
Index of the node who sent us
this
m
es
sage
* @param e The entry message */
int
raft_recv_entry
(
raft_server_t
*
me
,
int
node
,
msg_entry_t
*
e
);
...
...
@@ -294,8 +297,7 @@ raft_entry_t* raft_get_entry_from_idx(raft_server_t* me_, int idx);
/**
* @param node The node's index
* @return node pointed to by node index
*/
* @return node pointed to by node index */
raft_node_t
*
raft_get_node
(
raft_server_t
*
me_
,
int
node
);
/**
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment