m0_filterc_ops Struct Reference

#include <filterc.h>

Collaboration diagram for m0_filterc_ops:

Data Fields
int(*	fco_start )(struct m0_filterc_ctx *ctx, struct m0_reqh *reqh)
void(*	fco_stop )(struct m0_filterc_ctx *ctx)
int(*	fco_open )(struct m0_filterc_ctx *ctx, enum m0_fdmi_rec_type_id rec_type_id, struct m0_filterc_iter *iter)
int(*	fco_get_next )(struct m0_filterc_iter *iter, struct m0_conf_fdmi_filter **out)
void(*	fco_close )(struct m0_filterc_iter *iter)

Detailed Description

Definition at line 45 of file filterc.h.

Field Documentation

fco_close

void(* fco_close) (struct m0_filterc_iter *iter)

Closes FDMI filters iterator

Parameters

iter	Iterator to be closed

Definition at line 96 of file filterc.h.

fco_get_next

int(* fco_get_next) (struct m0_filterc_iter *iter, struct m0_conf_fdmi_filter **out)

Get next filter using iterator

Parameters

iter	FDMI filters iterator
out	output filter

Returns

0 if there is no available filter (all filters are traversed)
>0 if out parameter points to next filter
<0 some error occurred

Definition at line 89 of file filterc.h.

fco_open

int(* fco_open) (struct m0_filterc_ctx *ctx, enum m0_fdmi_rec_type_id rec_type_id, struct m0_filterc_iter *iter)

Open iterator for traversing FDMI filters with provided FDMI record type ID

Parameters

ctx	FDMI filter client context
rec_type_id	FDMI filter client context
iter	Iterator to be opened

Returns

0 if filters for provided FDMI record type are found and iterator is opened successfully;
error code otherwise

Definition at line 76 of file filterc.h.

fco_start

int(* fco_start) (struct m0_filterc_ctx *ctx, struct m0_reqh *reqh)

Start filterC instance. Should be called before opening any filterC iterator. After successful start any number of fco_open/fco_close calls is allowed.

Parameters

ctx	filterC context
reqh	request handler

Returns

0 if filterC is started successfully;
error code otherwise

Definition at line 56 of file filterc.h.

fco_stop

void(* fco_stop) (struct m0_filterc_ctx *ctx)

Stop filterC instance.

Parameters

ctx	filterC context

Definition at line 63 of file filterc.h.

---

The documentation for this struct was generated from the following file:

• fdmi/filterc.h