Package com._1c.g5.v8.bm.store

Interface IBmWorkLog

public interface IBmWorkLog

Work log.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IBmWorkLog.IEntryProcessor	Log entry processor.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes and deletes the log.
void	close(boolean delete)	Closes the log.
boolean	log(byte[] data, int offset, int length)	Adds log entry.
void	preStart(IBmWorkLog.IEntryProcessor entryProcessor)	Pre-starts the log.
void	reset()	Resets the log (all the entries are removed).
void	start()	Starts the log.

Method Detail

preStart

void preStart(IBmWorkLog.IEntryProcessor entryProcessor)
       throws IOException

Pre-starts the log. Invokes entry processor for each log entry if any.

Parameters:

entryProcessor - The entry processor. May not be null.

Throws:

IOException - if any I/O error occurs.

start

void start()
    throws IOException

Starts the log.

Throws:

IOException - if any I/O error occurs.

close

void close()
    throws IOException

Closes and deletes the log.

Throws:

IOException - if any I/O error occurs.

close

void close(boolean delete)
    throws IOException

Closes the log. In contrast to its zero-argument counterpart allows the user to decide whether the log file should be deleted.

Parameters:

delete - The flag indicating whether the log file should be deleted.

Throws:

IOException - if any I/O error occurs.

log

boolean log(byte[] data,
            int offset,
            int length)
     throws IOException

Adds log entry.

Parameters:

data - A byte array containing the log entry data. May not be null.

offset - The offset of the log entry data within the array.

length - The length of the entry data.

Returns:

true if the entry has been added, false if the log size reached the threshold.

Throws:

IOException - if any I/O error occurs.

reset

void reset()
    throws IOException

Resets the log (all the entries are removed).

Throws:

IOException - if any I/O error occurs.