m0_conf_obj_ops Struct Reference
#include <obj_ops.h>
Collaboration diagram for m0_conf_obj_ops:
Data Fields | |
| bool(* | coo_invariant )(const struct m0_conf_obj *obj) |
| int(* | coo_decode )(struct m0_conf_obj *dest, const struct m0_confx_obj *src) |
| int(* | coo_encode )(struct m0_confx_obj *dest, const struct m0_conf_obj *src) |
| bool(* | coo_match )(const struct m0_conf_obj *cached, const struct m0_confx_obj *flat) |
| int(* | coo_lookup )(const struct m0_conf_obj *parent, const struct m0_fid *name, struct m0_conf_obj **out) |
| int(* | coo_readdir )(const struct m0_conf_obj *dir, struct m0_conf_obj **pptr) |
| const struct m0_fid **(* | coo_downlinks )(const struct m0_conf_obj *obj) |
| void(* | coo_delete )(struct m0_conf_obj *obj) |
Detailed Description
Field Documentation
◆ coo_decode
| int(* coo_decode) (struct m0_conf_obj *dest, const struct m0_confx_obj *src) |
Populates concrete object with configuration data taken from m0_confx_obj.
Creates stubs of object's neighbours, if necessary.
◆ coo_delete
| void(* coo_delete) (struct m0_conf_obj *obj) |
Finalises concrete fields of given configuration object and frees it.
- See also
- m0_conf_obj_delete()
◆ coo_downlinks
| const struct m0_fid**(* coo_downlinks) (const struct m0_conf_obj *obj) |
Returns NULL-terminated array of the downlink fids of this conf object.
Downlink fid can be passed as ‘name’ parameter to ->coo_lookup().
- Note
- .coo_downlinks == NULL in the case of m0_conf_dir only.
◆ coo_encode
| int(* coo_encode) (struct m0_confx_obj *dest, const struct m0_conf_obj *src) |
◆ coo_invariant
| bool(* coo_invariant) (const struct m0_conf_obj *obj) |
◆ coo_lookup
| int(* coo_lookup) (const struct m0_conf_obj *parent, const struct m0_fid *name, struct m0_conf_obj **out) |
Finds a child of given object.
- Parameters
-
parent The object being searched. name Name of the relation leading to a child object. Identifier of the child object, if parent is a directory. out If the function succeeds, *out will point to the sought-for object.
- Precondition
- parent->co_status == M0_CS_READY
- Postcondition
- M0_IN(retval, (0, -ENOENT))
- ergo(retval == 0, m0_conf_obj_invariant(*out))
◆ coo_match
| bool(* coo_match) (const struct m0_conf_obj *cached, const struct m0_confx_obj *flat) |
◆ coo_readdir
| int(* coo_readdir) (const struct m0_conf_obj *dir, struct m0_conf_obj **pptr) |
Gets next directory entry.
- Parameters
-
dir Directory. [in] pptr "Current" entry. [out] pptr "Next" entry.
- Return values
-
M0_CONF_DIRMISS The next directory entry is missing from configuration cache or is a stub. M0_CONF_DIRNEXT *pptr now points to the next entry. M0_CONF_DIREND End of directory is reached. -Exxx Error.
->coo_readdir() puts (m0_conf_obj_put()) the configuration object referred to via ‘pptr’ input parameter.
->coo_readdir() pins (m0_conf_obj_get()) the resulting object in case of M0_CONF_DIRNEXT.
The documentation for this struct was generated from the following file:
- conf/obj_ops.h
