Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals  

dt_stream_base.c File Reference

Go to the source code of this file.

Functions

dt_bool dt_read (dt_reader *obj, dt_stream_step *step)
 Retrieve a streaming step from obj into step.

void dt_free_reader (dt_reader *obj)
 Destroy and free a dt_reader object.

dt_bool dt_write (dt_writer *obj, dt_stream_step const *step)
 Transmit the streaming step in step to obj.

void dt_free_writer (dt_writer *obj)
 Destroy and free a dt_writer object.

void dt_init_reader_base (dt_reader *reader, void(*free_impl)(dt_reader *), dt_bool(*read_impl)(dt_reader *, dt_stream_step *))
void dt_init_writer_base (dt_writer *writer, void(*free_impl)(dt_writer *), dt_bool(*write_impl)(dt_writer *, dt_stream_step const *))

Variables

unsigned dt_reader_instance_count = 0
 The number of dt_reader instances that currently exist. A debugging facility.

unsigned dt_writer_instance_count = 0
 The number of dt_writer instances that currently exist. A debugging facility.


Function Documentation

void dt_free_reader dt_reader obj  ) 
 

Destroy and free a dt_reader object.

Definition at line 28 of file dt_stream_base.c.

void dt_free_writer dt_writer obj  ) 
 

Destroy and free a dt_writer object.

Definition at line 53 of file dt_stream_base.c.

void dt_init_reader_base dt_reader reader,
void(*  free_impl)(dt_reader *),
dt_bool(*  read_impl)(dt_reader *, dt_stream_step *)
 

Definition at line 65 of file dt_stream_base.c.

void dt_init_writer_base dt_writer writer,
void(*  free_impl)(dt_writer *),
dt_bool(*  write_impl)(dt_writer *, dt_stream_step const *)
 

Definition at line 77 of file dt_stream_base.c.

dt_bool dt_read dt_reader obj,
dt_stream_step step
 

Retrieve a streaming step from obj into step.

This is a polymorphic function, which will use a subclass-specific forwarding function stored within the object.

Returns:
A non-zero value if the operation was successful.

Definition at line 19 of file dt_stream_base.c.

dt_bool dt_write dt_writer obj,
dt_stream_step const *  step
 

Transmit the streaming step in step to obj.

This is a polymorphic function, which will use a subclass-specific forwarding function stored within the object.

Returns:
A non-zero value if the operation was successful.

Definition at line 44 of file dt_stream_base.c.


Variable Documentation

unsigned dt_reader_instance_count = 0
 

The number of dt_reader instances that currently exist. A debugging facility.

Definition at line 8 of file dt_stream_base.c.

unsigned dt_writer_instance_count = 0
 

The number of dt_writer instances that currently exist. A debugging facility.

Definition at line 10 of file dt_stream_base.c.


Generated on Sun Jun 1 16:35:38 2003 for datatree by doxygen 1.3.1