README
¶
archiver
This library demonstrates reading from the nats.io event bus and storing Frame events to files on disk.
Documentation
¶
Index ¶
- Variables
- func DirExists(name string) bool
- func ExtractStreamFromSubject(subj string) (stream string, id string)
- func FileExists(name string) bool
- func HaveLock(f *os.File) bool
- func LockFile(f *os.File) error
- func UnlockFile(f *os.File) error
- func XtraDirs(id string) string
- type ArchiverConfig
- type Date
- type File
- type FileMgr
- func (fm *FileMgr) CloseUnusedFiles(olderThan time.Duration)
- func (fm *FileMgr) GetDateNameString(tm time.Time, streamName string) (string, Date)
- func (fm *FileMgr) GetPath(tm time.Time, streamName string) string
- func (fm *FileMgr) Run() error
- func (fm *FileMgr) Stop()
- func (fm *FileMgr) Store(tm time.Time, streamName string, data []byte) (f *File, err error)
- func (fm *FileMgr) Subscribe(subj string) error
- func (fm *FileMgr) Sync()
- func (fm *FileMgr) SyncAndCloseAllFiles()
Constants ¶
This section is empty.
Variables ¶
var DefaultCaPath string = "certs/my-demo-ca.pem"
DefaultCaPath: default location to look for the Certificate Authority certificate.
var DefaultCertDir string = "/etc/ssl"
where to look for certs by default (change this to your installation)
var DefaultCertPath string = "certs/my-demo-cert.crt"
DefaultCaPath: default location to look for this nodes certificate.
var DefaultKeyPath string = "private/my-demo-cert.key"
DefaultCaPath: default location to look for the this nodes private key.
var NoLockErr = fmt.Errorf("no flock lock was obtained")
NoLockErr is returned by LockFile when it fails to lock the file.
var ServiceName = "service-name"
ServiceName is how this service is addressed on the Nats bus.
Functions ¶
func FileExists ¶
func HaveLock ¶
HaveLock checks if we have an exclusive flock lock on the file. flocks(2) can be inherited by child processes.
func LockFile ¶
LockFile returns nil if the lock was obtained. If the lock was not obtained, NoLockErr is returned
func UnlockFile ¶
Unlock calls flock with LOCK_UN, and returns any error. Typically the returned error is nil whether we succeeded or not in unlocking the file. Note that the operating system automatically unlocks flocks when the process exits.
Types ¶
type ArchiverConfig ¶
func (*ArchiverConfig) DefineFlags ¶
func (c *ArchiverConfig) DefineFlags(fs *flag.FlagSet)
call DefineFlags before myflags.Parse()
func (*ArchiverConfig) ValidateConfig ¶
func (c *ArchiverConfig) ValidateConfig() error
call c.ValidateConfig() after myflags.Parse()
type File ¶
type File struct {
Key string
Date Date
StreamName string
Path string
Fd *os.File
EndOffset int64
LastErr error
LastWrite time.Time
}
File is an open file in our cache of file handles
type FileMgr ¶
type FileMgr struct {
Cfg ArchiverConfig
Files map[string]*File
Ready chan bool
ReqStop chan bool
Done chan bool
NatsAsyncErrCh chan asyncErr
NatsConnClosedCh chan *nats.Conn
NatsConnDisconCh chan *nats.Conn
NatsConnReconCh chan *nats.Conn
ArchiveReqCh chan *nats.Msg
SignalInterruptCh chan os.Signal
// contains filtered or unexported fields
}
func NewFileMgr ¶
func NewFileMgr(cfg *ArchiverConfig) *FileMgr
func (*FileMgr) CloseUnusedFiles ¶
close unaccessed files, to keep file handle count low.
func (*FileMgr) GetDateNameString ¶
provides index into File map
func (*FileMgr) SyncAndCloseAllFiles ¶
func (fm *FileMgr) SyncAndCloseAllFiles()
Source Files