package
1.3.3-alpha.0
Repository: https://github.com/yext/burrow.git
Documentation: pkg.go.dev

# Functions

GetSaramaConfigFromClientProfile takes the name of a client-profile configuration entry and returns a sarama.Config object that can be used to create a Sarama client with the specified configuration.
InitSaramaLogging assigns a new logger to sarama.Logger, which will send messages to given zap logger at debug level.
NewPausableTicker returns a Ticker that has not yet been started, but the channel is ready to use.
StartCoordinatorModules is a helper func for coordinators to start a list of modules.
StopCoordinatorModules is a helper func for coordinators to stop a list of modules.
TimeoutSendStorageRequest is a helper func for sending a protocol.StorageRequest to a channel with a timeout, specified in seconds.
ValidateEmail returns true if the provided string is an email address.
ValidateFilename returns true if the provided string is a sane-looking filename (not just a valid filename, which could be almost anything).
ValidateHostList returns true if the provided slice of strings can all be parsed by ValidateHostPort.
ValidateHostname returns true if the provided string can be parsed as a hostname.
ValidateHostPort returns true if the provided string is of the form "hostname:port", where hostname is a valid hostname or IP address (as parsed by ValidateIP or ValidateHostname), and port is a valid integer.
ValidateIP returns true if the provided string can be parsed as an IP address (either IPv4 or IPv6).
ValidateTopic returns true if the provided string is a valid topic name, which may only contain letters, numbers, underscores, dashes, and periods.
ValidateURL returns true if the provided string can be parsed as a URL.
ValidateZookeeperPath returns true if the provided string can be parsed as a Zookeeper node path.
ZookeeperConnect establishes a new connection to a pool of Zookeeper servers.
ZookeeperConnectTLS establishes a new TLS connection to a pool of Zookeeper servers.

# Variables

No description provided by the author
No description provided by the author

# Structs

BurrowSaramaBroker is an implementation of the SaramaBroker interface that is used with SaramaClient.
BurrowSaramaClient is an implementation of the SaramaClient interface for use in Burrow modules.
BurrowZookeeperClient is an implementation of protocol.ZookeeperClient.
MockModule is a mock of protocol.Module that also satisfies the various subsystem Module variants, and is used in tests.
MockSaramaBroker is a mock of SaramaBroker.
MockSaramaClient is a mock of SaramaClient.
MockSaramaConsumer is a mock of sarama.Consumer.
MockSaramaPartitionConsumer is a mock of sarama.PartitionConsumer.
MockTicker is a mock Ticker interface that can be used for testing.
MockZookeeperClient is a mock of the protocol.ZookeeperClient interface to be used for testing.
MockZookeeperLock is a mock of the protocol.ZookeeperLock interface.
PausableTicker is an implementation of Ticker which can be stopped and restarted without changing the underlying channel.
No description provided by the author

# Interfaces

SaramaBroker is an internal interface on the sarama.Broker struct.
SaramaClient is an internal interface to the sarama.Client.
Ticker is a generic interface for a channel that delivers `ticks' of a clock at intervals.