Documentation
¶
Overview ¶
Package broker implements types used for routing inputs to outputs in non-trivial arrangements, such as fan-out or fan-in models.
Index ¶
- func OptDynamicFanInSetOnAdd(onAddFunc func(label string)) func(*DynamicFanIn)
- func OptDynamicFanInSetOnRemove(onRemoveFunc func(label string)) func(*DynamicFanIn)
- func OptDynamicFanOutSetOnAdd(onAddFunc func(label string)) func(*DynamicFanOut)
- func OptDynamicFanOutSetOnRemove(onRemoveFunc func(label string)) func(*DynamicFanOut)
- type DynamicFanIn
- type DynamicFanOut
- type DynamicInput
- type DynamicOutput
- type FanIn
- type FanOut
- type Greedy
- type MockType
- type RoundRobin
- type Try
- type Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func OptDynamicFanInSetOnAdd ¶
func OptDynamicFanInSetOnAdd(onAddFunc func(label string)) func(*DynamicFanIn)
OptDynamicFanInSetOnAdd sets the function that is called whenever a dynamic input is added.
func OptDynamicFanInSetOnRemove ¶
func OptDynamicFanInSetOnRemove(onRemoveFunc func(label string)) func(*DynamicFanIn)
OptDynamicFanInSetOnRemove sets the function that is called whenever a dynamic input is removed.
func OptDynamicFanOutSetOnAdd ¶
func OptDynamicFanOutSetOnAdd(onAddFunc func(label string)) func(*DynamicFanOut)
OptDynamicFanOutSetOnAdd sets the function that is called whenever a dynamic output is added.
func OptDynamicFanOutSetOnRemove ¶
func OptDynamicFanOutSetOnRemove(onRemoveFunc func(label string)) func(*DynamicFanOut)
OptDynamicFanOutSetOnRemove sets the function that is called whenever a dynamic output is removed.
Types ¶
type DynamicFanIn ¶
type DynamicFanIn struct {
// contains filtered or unexported fields
}
DynamicFanIn is a broker that implements types.Producer and manages a map of inputs to unique string identifiers, routing them through a single message channel. Inputs can be added and removed dynamically as the broker runs.
func NewDynamicFanIn ¶
func NewDynamicFanIn( inputs map[string]DynamicInput, logger log.Modular, stats metrics.Type, options ...func(*DynamicFanIn), ) (*DynamicFanIn, error)
NewDynamicFanIn creates a new DynamicFanIn type by providing an initial map map of inputs.
func (*DynamicFanIn) CloseAsync ¶
func (d *DynamicFanIn) CloseAsync()
CloseAsync shuts down the DynamicFanIn broker and stops processing requests.
func (*DynamicFanIn) SetInput ¶
func (d *DynamicFanIn) SetInput(ident string, input DynamicInput, timeout time.Duration) error
SetInput attempts to add a new input to the dynamic input broker. If an input already exists with the same identifier it will be closed and removed. If either action takes longer than the timeout period an error will be returned.
A nil input is safe and will simply remove the previous input under the indentifier, if there was one.
func (*DynamicFanIn) TransactionChan ¶
func (d *DynamicFanIn) TransactionChan() <-chan types.Transaction
TransactionChan returns the channel used for consuming messages from this broker.
func (*DynamicFanIn) WaitForClose ¶
func (d *DynamicFanIn) WaitForClose(timeout time.Duration) error
WaitForClose blocks until the DynamicFanIn broker has closed down.
type DynamicFanOut ¶
type DynamicFanOut struct {
// contains filtered or unexported fields
}
DynamicFanOut is a broker that implements types.Consumer and broadcasts each message out to a dynamic map of outputs.
func NewDynamicFanOut ¶
func NewDynamicFanOut( outputs map[string]DynamicOutput, logger log.Modular, stats metrics.Type, options ...func(*DynamicFanOut), ) (*DynamicFanOut, error)
NewDynamicFanOut creates a new DynamicFanOut type by providing outputs.
func (*DynamicFanOut) CloseAsync ¶
func (d *DynamicFanOut) CloseAsync()
CloseAsync shuts down the DynamicFanOut broker and stops processing requests.
func (*DynamicFanOut) Consume ¶
func (d *DynamicFanOut) Consume(transactions <-chan types.Transaction) error
Consume assigns a new transactions channel for the broker to read.
func (*DynamicFanOut) SetOutput ¶
func (d *DynamicFanOut) SetOutput(ident string, output DynamicOutput, timeout time.Duration) error
SetOutput attempts to add a new output to the dynamic output broker. If an output already exists with the same identifier it will be closed and removed. If either action takes longer than the timeout period an error will be returned.
A nil output argument is safe and will simply remove the previous output under the indentifier, if there was one.
func (*DynamicFanOut) WaitForClose ¶
func (d *DynamicFanOut) WaitForClose(timeout time.Duration) error
WaitForClose blocks until the DynamicFanOut broker has closed down.
type DynamicInput ¶
DynamicInput is an interface of input types that must be closable.
type DynamicOutput ¶
DynamicOutput is an interface of output types that must be closable.
type FanIn ¶
type FanIn struct {
// contains filtered or unexported fields
}
FanIn is a broker that implements types.Producer, takes an array of inputs and routes them through a single message channel.
func (*FanIn) CloseAsync ¶
func (i *FanIn) CloseAsync()
CloseAsync shuts down the FanIn broker and stops processing requests.
func (*FanIn) TransactionChan ¶
func (i *FanIn) TransactionChan() <-chan types.Transaction
TransactionChan returns the channel used for consuming transactions from this broker.
type FanOut ¶
type FanOut struct {
// contains filtered or unexported fields
}
FanOut is a broker that implements types.Consumer and broadcasts each message out to an array of outputs.
func (*FanOut) CloseAsync ¶
func (o *FanOut) CloseAsync()
CloseAsync shuts down the FanOut broker and stops processing requests.
type Greedy ¶
type Greedy struct {
// contains filtered or unexported fields
}
Greedy is a broker that implements types.Consumer and sends each message out to a single consumer chosen from an array in round-robin fashion. Consumers that apply backpressure will block all consumers.
func (*Greedy) CloseAsync ¶
func (g *Greedy) CloseAsync()
CloseAsync shuts down the Greedy broker and stops processing requests.
type RoundRobin ¶
type RoundRobin struct {
// contains filtered or unexported fields
}
RoundRobin is a broker that implements types.Consumer and sends each message out to a single consumer chosen from an array in round-robin fashion. Consumers that apply backpressure will block all consumers.
func NewRoundRobin ¶
NewRoundRobin creates a new RoundRobin type by providing consumers.
func (*RoundRobin) CloseAsync ¶
func (o *RoundRobin) CloseAsync()
CloseAsync shuts down the RoundRobin broker and stops processing requests.
func (*RoundRobin) Consume ¶
func (o *RoundRobin) Consume(ts <-chan types.Transaction) error
Consume assigns a new messages channel for the broker to read.
func (*RoundRobin) WaitForClose ¶
func (o *RoundRobin) WaitForClose(timeout time.Duration) error
WaitForClose blocks until the RoundRobin broker has closed down.
type Try ¶
type Try struct {
// contains filtered or unexported fields
}
Try is a broker that implements types.Consumer and attempts to send each message to a single output, but on failure will attempt the next output in the list.
func (*Try) CloseAsync ¶
func (t *Try) CloseAsync()
CloseAsync shuts down the Try broker and stops processing requests.
Source Files