TFileReaderTransport

A transport used to read log files. It can never be written to, calling write() throws.

Contrary to the C++ design, explicitly opening the transport/file before using is necessary to allow manually closing the file without relying on the object lifetime. Otherwise, it's a straight port of the C++ implementation.

Constructors

this this(string path): Creates a new file writer transport.

Members

Functions

chunkSize ulong chunkSize()
void chunkSize(ulong value): The size of the chunks the file is divided into, in bytes.
close void close(): Undocumented in source. Be warned that the author may not have intended to support it.
corruptedEventSleepDuration Duration corruptedEventSleepDuration()
void corruptedEventSleepDuration(Duration value): The interval at which the thread wakes up to check for the next chunk in tailing mode.
getCurChunk ulong getCurChunk(): Undocumented in source. Be warned that the author may not have intended to support it.
getNumChunks ulong getNumChunks(): Undocumented in source. Be warned that the author may not have intended to support it.
isOpen bool isOpen(): Undocumented in source. Be warned that the author may not have intended to support it.
maxCorruptedEvents uint maxCorruptedEvents()
void maxCorruptedEvents(uint value): The maximum number of corrupted events tolerated before the whole chunk is skipped.
maxEventSize size_t maxEventSize()
void maxEventSize(size_t value): Arbitrary event size limit, in bytes. Must be smaller than chunk size.
open void open(): Undocumented in source. Be warned that the author may not have intended to support it.
peek bool peek(): Undocumented in source. Be warned that the author may not have intended to support it.
read size_t read(ubyte[] buf): Undocumented in source. Be warned that the author may not have intended to support it.
readBufferSize size_t readBufferSize()
void readBufferSize(size_t value): Read buffer size, in bytes.
readTimeout Duration readTimeout()
void readTimeout(Duration value): If positive, wait the specified duration for new data when arriving at end of file. If negative, wait forever (tailing mode), waking up to check in the specified interval. If zero, do not wait at all.
seekToChunk void seekToChunk(long chunk): Undocumented in source. Be warned that the author may not have intended to support it.
seekToEnd void seekToEnd(): Undocumented in source. Be warned that the author may not have intended to support it.

Manifest constants

DEFAULT_CORRUPTED_EVENT_SLEEP_DURATION enum DEFAULT_CORRUPTED_EVENT_SLEEP_DURATION;: The interval at which the thread wakes up to check for the next chunk in tailing mode.
DEFAULT_MAX_CORRUPTED_EVENTS enum DEFAULT_MAX_CORRUPTED_EVENTS;: The maximum number of corrupted events tolerated before the whole chunk is skipped.
DEFAULT_MAX_EVENT_SIZE enum DEFAULT_MAX_EVENT_SIZE;: Arbitrary event size limit, in bytes. Must be smaller than chunk size.
DEFAULT_READ_BUFFER_SIZE enum DEFAULT_READ_BUFFER_SIZE;: Read buffer size, in bytes.
DEFAULT_READ_TIMEOUT enum DEFAULT_READ_TIMEOUT;: If positive, wait the specified duration for new data when arriving at end of file. If negative, wait forever (tailing mode), waking up to check in the specified interval. If zero, do not wait at all.

Inherited Members

From TBaseTransport

isOpen bool isOpen(): Undocumented in source. Be warned that the author may not have intended to support it.
peek bool peek(): Undocumented in source. Be warned that the author may not have intended to support it.
open void open(): Undocumented in source. Be warned that the author may not have intended to support it.
close void close(): Undocumented in source. Be warned that the author may not have intended to support it.
read size_t read(ubyte[] buf): Undocumented in source. Be warned that the author may not have intended to support it.
readAll void readAll(ubyte[] buf): Undocumented in source. Be warned that the author may not have intended to support it.
readEnd size_t readEnd(): Undocumented in source. Be warned that the author may not have intended to support it.
write void write(ubyte[] buf): Undocumented in source. Be warned that the author may not have intended to support it.
writeEnd size_t writeEnd(): Undocumented in source. Be warned that the author may not have intended to support it.
flush void flush(): Undocumented in source. Be warned that the author may not have intended to support it.
borrow const(ubyte)[] borrow(ubyte* buf, size_t len): Undocumented in source. Be warned that the author may not have intended to support it.
consume void consume(size_t len): Undocumented in source. Be warned that the author may not have intended to support it.