path: root/WWW/Library/Implementation/HTStream.h

/*
 * $LynxId: HTStream.h,v 1.16 2011/06/11 12:08:40 tom Exp $
 *
 *                                                      The Stream class definition -- libwww
                                 STREAM OBJECT DEFINITION

   A Stream object is something which accepts a stream of text.

   The creation methods will vary on the type of Stream Object.  All creation
   methods return a pointer to the stream type below.

   As you can see, but the methods used to write to the stream and close it are
   pointed to be the object itself.

 */
#ifndef HTSTREAM_H
#define HTSTREAM_H

#ifndef HTUTILS_H
#include <HTUtils.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif
    typedef struct _HTStream HTStream;

/*

   These are the common methods of all streams.  They should be
   self-explanatory.

 */
    typedef struct _HTStreamClass {

	const char *name;	/* Just for diagnostics */

	void (*_free) (HTStream *me);

	void (*_abort) (HTStream *me, HTError e);

	void (*put_character) (HTStream *me, int ch);

	void (*put_string) (HTStream *me, const char *str);

	void (*put_block) (HTStream *me, const char *str, int len);

    } HTStreamClass;

#ifndef HTSTREAM_INTERNAL
    struct _HTStream {
	HTStreamClass *isa;
    };
#endif
/*

  Generic Error Stream

   The Error stream simply signals an error on all output methods.
   This can be used to stop a stream as soon as data arrives, for
   example from the network.

 */
    extern HTStream *HTErrorStream(void);

#ifdef __cplusplus
}
#endif
#endif				/* HTSTREAM_H */