2 * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file write.h Writer-related structures. */
9 /** The list of supported writers. */
10 enum writer_enum {WRITER_ENUM};
13 * Describes one running instance of a writer.
16 /** The number of this writer. */
18 /** Writer-specific data. */
20 /** The writer-specific configuration of this node. */
22 struct btr_node *btrn;
27 /** Describes one supported writer. */
30 * The init function of the writer.
32 * It must fill in all other function pointers of the given
35 void (*init)(struct writer *w);
37 * The command line parser of the writer.
39 * It should check whether the command line options given by \a options are
40 * valid. On success, it should return a pointer to the writer-specific
41 * configuration data determined by \a options. Note that this might be called
42 * more than once with different values of \a options. \sa \ref free_config().
44 void *(*parse_config)(const char *options);
46 * Dellocate all configuration resources.
48 * This should free whatever was allocated by \ref parse_config().
50 void (*free_config)(void *config);
52 * Open one instance of this writer.
54 * This function should perform any work necessary to write the incoming
55 * stream. To this aim, it may allocate its private data structure and store
56 * a pointer to that structure via the given writer_node parameter.
58 int (*open)(struct writer_node *);
60 * Prepare the fd sets for select.
62 * This is called from scheduler. It may use the sched pointer to add
63 * any file descriptors or to decrease the select timeout.
65 void (*pre_select)(struct sched *s, struct task *t);
69 * Called from the post_select function of the writer node's task.
71 void (*post_select)(struct sched *s, struct task *t);
73 * Close one instance of the writer.
75 * This function is assumed to succeed.
77 void (*close)(struct writer_node *);
81 * This is a optional function pointer used for cleaning up.
83 void (*shutdown)(struct writer_node *);
85 btr_command_handler execute;
88 /** Loop over each supported writer. */
89 #define FOR_EACH_WRITER(i) for (i = 0; i < NUM_SUPPORTED_WRITERS; i++)
91 /** Declare the init functions of all supported writers. */
94 /** Array containing the name of each writer. */
95 extern const char *writer_names[];
97 /** The writer structure for each supported writer. */
98 extern struct writer writers[NUM_SUPPORTED_WRITERS];