#include <source_dock.h>

Collaboration diagram for m0_fdmi_src:

Data Fields
enum m0_fdmi_rec_type_id	fs_type_id

void(*	fs_record_post )(struct m0_fdmi_src_rec *src_rec)

int(*	fs_node_eval )(struct m0_fdmi_src_rec src_rec, struct m0_fdmi_flt_var_node value_desc, struct m0_fdmi_flt_operand *value)

void(*	fs_get )(struct m0_fdmi_src_rec *src_rec)

void(*	fs_put )(struct m0_fdmi_src_rec *src_rec)

void(*	fs_begin )(struct m0_fdmi_src_rec *src_rec)

void(*	fs_end )(struct m0_fdmi_src_rec *src_rec)

int(*	fs_encode )(struct m0_fdmi_src_rec src_rec, struct m0_buf buf)

int(*	fs_decode )(struct m0_buf buf, void *handle)

Detailed Description

FDMI source

Definition at line 47 of file source_dock.h.

Field Documentation

◆ fs_begin

void(* fs_begin) (struct m0_fdmi_src_rec *src_rec)

Processing of FDMI record is about to start. Optional.

Definition at line 70 of file source_dock.h.

◆ fs_decode

int(* fs_decode) (struct m0_buf *buf, void **handle)

Xcode function: decoding from buf.

Parameters

handle - OUT param to return the object which is a result of decoding. Memory is allocated inside 'decode'. Caller is responsible for freeing it. It is also assumed that caller knows the exact type of the result.

Definition at line 92 of file source_dock.h.

◆ fs_encode

int(* fs_encode) (struct m0_fdmi_src_rec *src_rec, struct m0_buf *buf)

Xcode function: encoding at given location.

Parameters

buf	- encoding result will be saved into this buffer. Memory will be allocated by the encode method. 'buf' must not be preallocated (expected buf->b_addr == NULL).

Definition at line 82 of file source_dock.h.

◆ fs_end

void(* fs_end) (struct m0_fdmi_src_rec *src_rec)

Processing of FDMI record is complete and can be freed. Optional.

Definition at line 72 of file source_dock.h.

◆ fs_get

void(* fs_get) (struct m0_fdmi_src_rec *src_rec)

Function to increment source specific ref counter. Optional.

Definition at line 66 of file source_dock.h.

◆ fs_node_eval

int(* fs_node_eval) (struct m0_fdmi_src_rec *src_rec, struct m0_fdmi_flt_var_node *value_desc, struct m0_fdmi_flt_operand *value)

Function to return specific source field value according to its description. Mandatory.

Definition at line 62 of file source_dock.h.

◆ fs_put

void(* fs_put) (struct m0_fdmi_src_rec *src_rec)

Function to decrement source specific ref counter. Optional.

Definition at line 68 of file source_dock.h.

◆ fs_record_post

void(* fs_record_post) (struct m0_fdmi_src_rec *src_rec)

Function to post FDMI data

Definition at line 54 of file source_dock.h.

◆ fs_type_id

enum m0_fdmi_rec_type_id fs_type_id

Source/record type identifier

Definition at line 49 of file source_dock.h.

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

fdmi/source_dock.h

Data Fields