fschannel

Documentation

Overview

Copyright 2016-2019 DutchSec (https://dutchsec.com/)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016-2019 DutchSec (https://dutchsec.com/)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func New(options ...func(pushers.Channel) error) (pushers.Channel, error)
• func OpenRotateFile(name string, mode os.FileMode, maxSize int64) (*rotateFile, error)
• type FileBackend
  • func (f *FileBackend) Close()
  • func (f *FileBackend) Send(message event.Event)
• type FileConfig

Functions

func New

func New(options ...func(pushers.Channel) error) (pushers.Channel, error)

New returns a new instance of a FileBackend.

func OpenRotateFile

func OpenRotateFile(name string, mode os.FileMode, maxSize int64) (*rotateFile, error)

Types

type FileBackend

type FileBackend struct {
	FileConfig
	// contains filtered or unexported fields
}

FileBackend defines a struct which implements the pushers.Pusher interface and allows us to write PushMessage updates into a giving file path. Mainly for the need to sync PushMessage to local files for persistence. File paths provided are either created with a append mode if they already exists else will be created. FileBackend will also restrict filesize to a max of 1gb by default else if there exists a max size set in configuration, then that will be used instead, also the old file will be renamed with the current timestamp and a new file created.

func (*FileBackend) Close

func (f *FileBackend) Close()

func (*FileBackend) Send

func (f *FileBackend) Send(message event.Event)

Send delivers the giving if it passes all filtering criteria into the FileBackend write queue.

type FileConfig

type FileConfig struct {
	MaxSize int64       `toml:"maxsize"`
	File    string      `toml:"filename"`
	Mode    os.FileMode `toml:"mode"`
}

FileConfig defines the config used to setup the FileBackend.