interface documentation.

to a big part stolen from the logging framework
This commit is contained in:
Bernhard Amann 2012-02-16 11:27:10 -08:00
parent a850cc5992
commit 84883348ec
6 changed files with 350 additions and 32 deletions

View file

@ -4,11 +4,14 @@
module Input;
export {
redef enum Input::ID += { TABLE_READ };
## The default input reader used. Defaults to `READER_ASCII`.
const default_reader = READER_ASCII &redef;
const default_mode = MANUAL &redef;
## Stream decription type used for the `create_stream` method
type StreamDescription: record {
## String that allows the reader to find the source.
@ -17,6 +20,9 @@ export {
## Reader to use for this steam
reader: Reader &default=default_reader;
## Read mode to use for this stream
mode: Mode &default=default_mode;
};
## TableFilter description type used for the `add_tablefilter` method.