object/stevedore: document required vs. optional callbacks

parent 20d25798
......@@ -51,15 +51,17 @@ typedef void *objsetattr_f(struct worker *, struct objcore *,
typedef void objtouch_f(struct worker *, struct objcore *, vtim_real now);
struct obj_methods {
/* required */
objfree_f *objfree;
objiterator_f *objiterator;
objgetspace_f *objgetspace;
objextend_f *objextend;
objgetattr_f *objgetattr;
objsetattr_f *objsetattr;
/* optional */
objtrimstore_f *objtrimstore;
objbocdone_f *objbocdone;
objslim_f *objslim;
objgetattr_f *objgetattr;
objsetattr_f *objsetattr;
objtouch_f *objtouch;
objsetstate_f *objsetstate;
};
......
......@@ -95,7 +95,9 @@ struct stevedore {
/* Called in MGT process */
storage_init_f *init;
/* Called in cache process */
/* Called in cache process
* only allocobj is required, other callbacks are optional
*/
storage_open_f *open;
storage_close_f *close;
storage_allocobj_f *allocobj;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment