Skip to content

Commit

Permalink
Add documentation for unschedFunction
Browse files Browse the repository at this point in the history
Summary:
Documenting the unschedFunction parameter to Schedule as
requested by Michael Kolupaev.

Test Plan: build, unit test

Reviewers: sdong, IslamAbdelRahman

Reviewed By: IslamAbdelRahman

Subscribers: kolmike, dhruba

Differential Revision: https://reviews.facebook.net/D52089
  • Loading branch information
rven1 committed Dec 17, 2015
1 parent 167fb91 commit 6b2a3ac
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions include/rocksdb/env.h
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,8 @@ class Env {
// added to the same Env may run concurrently in different threads.
// I.e., the caller may not assume that background work items are
// serialized.
// When the UnSchedule function is called, the unschedFunction
// registered at the time of Schedule is invoked with arg as a parameter.
virtual void Schedule(void (*function)(void* arg), void* arg,
Priority pri = LOW, void* tag = nullptr,
void (*unschedFunction)(void* arg) = 0) = 0;
Expand Down

0 comments on commit 6b2a3ac

Please sign in to comment.