Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ruanhaishen
Willemt Raft
Commits
d35cf92d
Commit
d35cf92d
authored
Feb 27, 2014
by
willem
Browse files
Better documentation for raft_log.h
parent
0a55c7f8
Changes
2
Show whitespace changes
Inline
Side-by-side
include/raft_log.h
View file @
d35cf92d
...
@@ -6,12 +6,32 @@ typedef void* log_t;
...
@@ -6,12 +6,32 @@ typedef void* log_t;
log_t
*
log_new
();
log_t
*
log_new
();
/**
* Add entry to log.
* Don't add entry if we've already added this entry (based off ID)
* Don't add entries with ID=0
* @return 0 if unsucessful; 1 otherwise */
int
log_append_entry
(
log_t
*
me_
,
raft_entry_t
*
c
);
int
log_append_entry
(
log_t
*
me_
,
raft_entry_t
*
c
);
int
log_count
(
log_t
*
me_
);
int
log_count
(
log_t
*
me_
);
/**
* Delete all logs from this log onwards */
void
log_delete
(
log_t
*
me_
,
int
idx
);
/**
* Empty the queue. */
void
log_empty
(
log_t
*
me_
);
/**
* Remove oldest entry
* @return oldest entry */
void
*
log_poll
(
log_t
*
me_
);
raft_entry_t
*
log_get_from_idx
(
log_t
*
me_
,
int
idx
);
raft_entry_t
*
log_get_from_idx
(
log_t
*
me_
,
int
idx
);
/*
* @return youngest entry */
raft_entry_t
*
log_peektail
(
log_t
*
me_
);
raft_entry_t
*
log_peektail
(
log_t
*
me_
);
void
log_mark_peer_has_committed
(
log_t
*
me_
,
int
idx
);
void
log_mark_peer_has_committed
(
log_t
*
me_
,
int
idx
);
...
...
raft_log.c
View file @
d35cf92d
...
@@ -5,7 +5,7 @@
...
@@ -5,7 +5,7 @@
* found in the LICENSE file.
* found in the LICENSE file.
*
*
* @file
* @file
* @brief ADT for managing Raft log entries (aka entr
y
s)
* @brief ADT for managing Raft log entries (aka entr
ie
s)
* @author Willem Thiart himself@willemthiart.com
* @author Willem Thiart himself@willemthiart.com
* @version 0.1
* @version 0.1
*/
*/
...
@@ -78,11 +78,6 @@ log_t* log_new()
...
@@ -78,11 +78,6 @@ log_t* log_new()
return
(
void
*
)
me
;
return
(
void
*
)
me
;
}
}
/**
* Add entry to log.
* Don't add entry if we've already added this entry (based off ID)
* Don't add entries with ID=0
* @return 0 if unsucessful; 1 otherwise */
int
log_append_entry
(
log_t
*
me_
,
raft_entry_t
*
c
)
int
log_append_entry
(
log_t
*
me_
,
raft_entry_t
*
c
)
{
{
log_private_t
*
me
=
(
void
*
)
me_
;
log_private_t
*
me
=
(
void
*
)
me_
;
...
@@ -122,8 +117,6 @@ int log_count(log_t* me_)
...
@@ -122,8 +117,6 @@ int log_count(log_t* me_)
return
me
->
count
;
return
me
->
count
;
}
}
/**
* Delete all logs from this log onwards */
void
log_delete
(
log_t
*
me_
,
int
idx
)
void
log_delete
(
log_t
*
me_
,
int
idx
)
{
{
log_private_t
*
me
=
(
void
*
)
me_
;
log_private_t
*
me
=
(
void
*
)
me_
;
...
@@ -156,9 +149,6 @@ void log_delete(log_t* me_, int idx)
...
@@ -156,9 +149,6 @@ void log_delete(log_t* me_, int idx)
#endif
#endif
}
}
/**
* Remove oldest entry
* @return oldest entry */
void
*
log_poll
(
log_t
*
me_
)
void
*
log_poll
(
log_t
*
me_
)
{
{
log_private_t
*
me
=
(
void
*
)
me_
;
log_private_t
*
me
=
(
void
*
)
me_
;
...
@@ -173,8 +163,6 @@ void *log_poll(log_t * me_)
...
@@ -173,8 +163,6 @@ void *log_poll(log_t * me_)
return
(
void
*
)
elem
;
return
(
void
*
)
elem
;
}
}
/*
* @return youngest entry */
raft_entry_t
*
log_peektail
(
log_t
*
me_
)
raft_entry_t
*
log_peektail
(
log_t
*
me_
)
{
{
log_private_t
*
me
=
(
void
*
)
me_
;
log_private_t
*
me
=
(
void
*
)
me_
;
...
@@ -190,8 +178,6 @@ raft_entry_t *log_peektail(log_t * me_)
...
@@ -190,8 +178,6 @@ raft_entry_t *log_peektail(log_t * me_)
return
&
me
->
entries
[
me
->
back
-
1
];
return
&
me
->
entries
[
me
->
back
-
1
];
}
}
/**
* Empty the queue. */
void
log_empty
(
log_t
*
me_
)
void
log_empty
(
log_t
*
me_
)
{
{
log_private_t
*
me
=
(
void
*
)
me_
;
log_private_t
*
me
=
(
void
*
)
me_
;
...
...
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