none.go

// Copyright (c) 2014 Ashley Jeffs
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package buffer

import (
	"sync/atomic"
	"time"

	"github.com/Jeffail/benthos/lib/types"
	"github.com/Jeffail/benthos/lib/util/service/log"
	"github.com/Jeffail/benthos/lib/util/service/metrics"
	"github.com/Jeffail/benthos/lib/util/throttle"
)

//------------------------------------------------------------------------------

func init() {
	constructors["none"] = typeSpec{
		constructor: NewEmpty,
		description: `
Selecting no buffer (default) is the lowest latency option since no extra work
is done to messages that pass through. With this option back pressure from the
output will be directly applied down the pipeline.`,
	}
}

//------------------------------------------------------------------------------

// Empty is an empty buffer, simply forwards messages on directly.
type Empty struct {
	running int32

	throt *throttle.Type

	messagesOut  chan types.Message
	responsesOut chan types.Response

	messagesIn  <-chan types.Message
	responsesIn <-chan types.Response

	closeChan chan struct{}
	closed    chan struct{}
}

// NewEmpty creates a new buffer interface but doesn't buffer messages.
func NewEmpty(config Config, log log.Modular, stats metrics.Type) (Type, error) {
	e := &Empty{
		running:      1,
		messagesOut:  make(chan types.Message),
		responsesOut: make(chan types.Response),
		closeChan:    make(chan struct{}),
		closed:       make(chan struct{}),
	}
	e.throt = throttle.New(
		throttle.OptCloseChan(e.closeChan),
		throttle.OptThrottlePeriod(
			time.Millisecond*time.Duration(config.RetryThrottleMS),
		),
	)
	return e, nil
}

//------------------------------------------------------------------------------

// loop is an internal loop of the empty buffer.
func (e *Empty) loop() {
	defer func() {
		atomic.StoreInt32(&e.running, 0)

		close(e.responsesOut)
		close(e.messagesOut)
		close(e.closed)
	}()

	var open bool
	for atomic.LoadInt32(&e.running) == 1 {
		var msg types.Message
		if msg, open = <-e.messagesIn; !open {
			return
		}
		select {
		case e.messagesOut <- msg:
		case <-e.closeChan:
			return
		}
		var res types.Response
		if res, open = <-e.responsesIn; !open {
			return
		}
		if res.Error() != nil {
			// Back off on consectutive retries
			e.throt.Retry()
		} else {
			e.throt.Reset()
		}
		select {
		case e.responsesOut <- res:
		case <-e.closeChan:
			return
		}
	}
}

//------------------------------------------------------------------------------

// StartReceiving assigns a messages channel for the output to read.
func (e *Empty) StartReceiving(msgs <-chan types.Message) error {
	if e.messagesIn != nil {
		return types.ErrAlreadyStarted
	}
	e.messagesIn = msgs
	if e.responsesIn != nil {
		go e.loop()
	}
	return nil
}

// MessageChan returns the channel used for consuming messages from this input.
func (e *Empty) MessageChan() <-chan types.Message {
	return e.messagesOut
}

// StartListening sets the channel for reading responses.
func (e *Empty) StartListening(responses <-chan types.Response) error {
	if e.responsesIn != nil {
		return types.ErrAlreadyStarted
	}
	e.responsesIn = responses
	if e.messagesIn != nil {
		go e.loop()
	}
	return nil
}

// ResponseChan returns the response channel.
func (e *Empty) ResponseChan() <-chan types.Response {
	return e.responsesOut
}

// ErrorsChan returns the errors channel.
func (e *Empty) ErrorsChan() <-chan []error {
	return nil
}

// CloseAsync shuts down the StackBuffer output and stops processing messages.
func (e *Empty) CloseAsync() {
	if atomic.CompareAndSwapInt32(&e.running, 1, 0) {
		close(e.closeChan)
	}
}

// WaitForClose blocks until the StackBuffer output has closed down.
func (e *Empty) WaitForClose(timeout time.Duration) error {
	select {
	case <-e.closed:
	case <-time.After(timeout):
		return types.ErrTimeout
	}
	return nil
}

//------------------------------------------------------------------------------