import "github.com/tendermint/tendermint/libs/autofile"
GroupCheckDuration allows you to overwrite default groupCheckDuration.
GroupHeadSizeLimit allows you to overwrite default head size limit - 10MB.
GroupTotalSizeLimit allows you to overwrite default total size limit of the group - 1GB.
AutoFile automatically closes and re-opens file for writing. The file is automatically setup to close itself every 1s and upon receiving SIGHUP.
This is useful for using a log file with the logrotate tool.
OpenAutoFile creates an AutoFile in the path (with random ID). If there is an error, it will be of type *PathError or *ErrPermissionsChanged (if file's permissions got changed (should be 0600)).
Close shuts down the closing goroutine, SIGHUP handler and closes the AutoFile.
Size returns the size of the AutoFile. It returns -1 and an error if fails get stats or open file. Opens AutoFile if needed.
Sync commits the current contents of the file to stable storage. Typically, this means flushing the file system's in-memory copy of recently written data to disk. Opens AutoFile if needed.
Write writes len(b) bytes to the AutoFile. It returns the number of bytes written and an error, if any. Write returns a non-nil error when n != len(b). Opens AutoFile if needed.
type Group struct {
cmn.BaseService
ID string
Head *AutoFile // The head AutoFile to write to
Dir string // Directory that contains .Head
// contains filtered or unexported fields
}You can open a Group to keep restrictions on an AutoFile, like the maximum size of each chunk, and/or the total amount of bytes stored in the group.
The first file to be written in the Group.Dir is the head file.
Dir/ - <HeadPath>
Once the Head file reaches the size limit, it will be rotated.
Dir/ - <HeadPath>.000 // First rolled file - <HeadPath> // New head path, starts empty. // The implicit index is 001.
As more files are written, the index numbers grow...
Dir/ - <HeadPath>.000 // First rolled file - <HeadPath>.001 // Second rolled file - ... - <HeadPath> // New head path
The Group can also be used to binary-search for some line, assuming that marker lines are written occasionally.
OpenGroup creates a new Group with head at headPath. It returns an error if it fails to open head file.
Buffered returns the size of the currently buffered data.
Close closes the head file. The group must be stopped by this moment.
FlushAndSync writes any buffered data to the underlying file and commits the current content of the file to stable storage (fsync).
HeadSizeLimit returns the current head size limit.
MaxIndex returns index of the last file in the group.
MinIndex returns index of the first file in the group.
func (g *Group) NewReader(index int) (*GroupReader, error)
NewReader returns a new group reader. CONTRACT: Caller must close the returned GroupReader.
OnStart implements cmn.Service by starting the goroutine that checks file and group limits.
OnStop implements cmn.Service by stopping the goroutine described above. NOTE: g.Head must be closed separately using Close.
Returns info after scanning all files in g.Head's dir.
RotateFile causes group to close the current head and assign it some index. Note it does not create a new head.
TotalSizeLimit returns total size limit of the group.
Wait blocks until all internal goroutines are finished. Supposed to be called after Stop.
Write writes the contents of p into the current head of the group. It returns the number of bytes written. If nn < len(p), it also returns an error explaining why the write is short. NOTE: Writes are buffered so they don't write synchronously TODO: Make it halt if space is unavailable
WriteLine writes line into the current head of the group. It also appends "\n". NOTE: Writes are buffered so they don't write synchronously TODO: Make it halt if space is unavailable
type GroupInfo struct {
MinIndex int // index of the first file in the group, including head
MaxIndex int // index of the last file in the group, including head
TotalSize int64 // total size of the group
HeadSize int64 // size of the head
}GroupInfo holds information about the group.
GroupReader provides an interface for reading from a Group.
func (gr *GroupReader) Close() error
Close closes the GroupReader by closing the cursor file.
func (gr *GroupReader) CurIndex() int
CurIndex returns cursor's file index.
func (gr *GroupReader) Read(p []byte) (n int, err error)
Read implements io.Reader, reading bytes from the current Reader incrementing index until enough bytes are read.
func (gr *GroupReader) SetIndex(index int) error
SetIndex sets the cursor's file index to index by opening a file at this position.
| Path | Synopsis |
|---|---|
| cmd |
Package autofile imports 15 packages (graph) and is imported by 5 packages. Updated 2019-08-03. Refresh now. Tools for package owners.