X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=1a3f193ddcd89369f6456a715dd56bde7650a42b;hp=63efbfed4d381a94783bf7749a4547ba7151099e;hb=9f021e58c181e2cd2e1e245fcd7b84f33ad50f9d;hpb=a5048b7349e87f323b4de87da44c564c619fc605 diff --git a/write.h b/write.h index 63efbfed..1a3f193d 100644 --- a/write.h +++ b/write.h @@ -1,19 +1,7 @@ /* - * Copyright (C) 2006 Andre Noll + * Copyright (C) 2006-2008 Andre Noll * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file write.h writer-related structures */ @@ -22,7 +10,7 @@ enum writer_enum {WRITER_ENUM}; /** - * decbribes one running instance of a writer + * Describes one running instance of a writer. */ struct writer_node { /** points to the writer structure associated with this node */ @@ -60,14 +48,14 @@ struct writer { * more than once with different values of \a options. * */ - void * (*parse_config)(char *options); + void * (*parse_config)(const char *options); /** * * open one instance of this writer * * This function should perform any work necessary to write the incoming * stream. If To this aim, it may allocate its private data structure and store - * a pointer to that structure via the given writer_node paramenter. + * a pointer to that structure via the given writer_node parameter. */ int (*open)(struct writer_node *); /** @@ -80,9 +68,9 @@ struct writer { * on errors. */ int (*pre_select)(struct sched *s, struct writer_node *wn); - /* + /** * Called from the post_select function of the wng task. It must keep - * track of the the number of bytes consumed from the wng's buffer via + * track of the number of bytes consumed from the wng's buffer via * the wn->written variable (which may be modified by the wng handling * functions). This function must return positive on success and * negative on errors. @@ -113,10 +101,10 @@ struct writer_node_group { struct writer_node *writer_nodes; /** the maximum of the chunk_bytes values of the writer nodes in this group */ size_t max_chunk_bytes; - /** non-zero if end of file was encountered by the feeding task */ - int *input_eof; - /** non-zero if end of file was encountered */ - int eof; + /** Non-zero if an error or end of file was encountered by the feeding task. */ + int *input_error; + /** Non-zero if an error occurred or end of file was encountered. */ + int error; /** current output buffer */ char *buf; /** number of bytes loaded in the output buffer */