Documentation
¶
Overview ¶
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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type RateLimitedEventSource ¶
type RateLimitedEventSource struct {
// contains filtered or unexported fields
}
The ratelimiter is a kind of man-in-the-middle. It provides an input interface with a channel for a writter to send events at any rate and an ouput interface with another channel where a reader will receive events at a configured rate At the input interface the main goals are: - writer should not block at all or tha minimum time possible. - If there is no more room for events in the "bucket" the write should not block at all but "fail" silently. At the output interface the reader should get the events not faster than the configured rate, blocking if there is no event to read.
func NewRateLimitedEventSource ¶
func NewRateLimitedEventSource(es notification.EventSource, maxEventsPerTimeUnit uint64, timeUnit time.Duration) (*RateLimitedEventSource, error)
func (*RateLimitedEventSource) Close ¶
func (rles *RateLimitedEventSource) Close()
func (*RateLimitedEventSource) Events ¶
func (rles *RateLimitedEventSource) Events() <-chan notification.Event
func (*RateLimitedEventSource) Run ¶
func (rles *RateLimitedEventSource) Run()
func (*RateLimitedEventSource) Stop ¶
func (rles *RateLimitedEventSource) Stop()
func (*RateLimitedEventSource) Wait ¶
func (rles *RateLimitedEventSource) Wait()
Source Files