Class KafkaBroker

An IBroker implementation for Apache Kafka.

Inheritance

object

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>

KafkaBroker

Implements

IBroker

IDisposable

Inherited Members

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.ProducerEndpointType

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.ConsumerEndpointType

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.Producers

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.Consumers

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.IsConnected

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.GetProducer(IProducerEndpoint)

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.GetProducer(string)

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.AddConsumer(IConsumerEndpoint)

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.ConnectAsync()

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.DisconnectAsync()

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.Dispose()

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.InstantiateProducer(KafkaProducerEndpoint, IBrokerBehaviorsProvider<IProducerBehavior>, IServiceProvider)

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.InstantiateConsumer(KafkaConsumerEndpoint, IBrokerBehaviorsProvider<IConsumerBehavior>, IServiceProvider)

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.ConnectAsync(IReadOnlyCollection<IProducer>, IReadOnlyCollection<IConsumer>)

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.DisconnectAsync(IReadOnlyCollection<IProducer>, IReadOnlyCollection<IConsumer>)

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.Dispose(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.Broker

Assembly: Silverback.Integration.Kafka.dll

Syntax

public class KafkaBroker : Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>, IBroker, IDisposable

Constructors

KafkaBroker(IServiceProvider)

Initializes a new instance of the KafkaBroker class.

Declaration

public KafkaBroker(IServiceProvider serviceProvider)

Parameters

Type	Name	Description
IServiceProvider	serviceProvider	The IServiceProvider to be used to resolve the required services.

Methods

Dispose(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	A value indicating whether the method has been called by the Dispose method and not from the finalizer.

Overrides

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.Dispose(bool)

GetProducer(IProducerEndpoint)

Returns an IProducer to be used to produce to the specified endpoint.

Declaration

public override IProducer GetProducer(IProducerEndpoint endpoint)

Parameters

Type	Name	Description
IProducerEndpoint	endpoint	The target endpoint.

Returns

Type	Description
IProducer	The IProducer for the specified endpoint.

Overrides

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.GetProducer(IProducerEndpoint)

GetProducer(string)

Returns an IProducer to be used to produce to the specified endpoint.

Declaration

public override IProducer GetProducer(string endpointName)

Parameters

Type	Name	Description
string	endpointName	The target endpoint name (or friendly name).

Returns

Type	Description
IProducer	The IProducer for the specified endpoint.

Overrides

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.GetProducer(string)

GetTransactionalProducer(IProducerEndpoint)

Returns a KafkaTransactionalProducer to be used to produce to the specified endpoint using a transaction.

Declaration

public KafkaTransactionalProducer GetTransactionalProducer(IProducerEndpoint endpoint)

Parameters

Type	Name	Description
IProducerEndpoint	endpoint	The target endpoint.

Returns

Type	Description
KafkaTransactionalProducer	The IProducer for the specified endpoint.

GetTransactionalProducer(string)

Returns an existing IProducer to be used to produce to the specified endpoint.

Declaration

public KafkaTransactionalProducer GetTransactionalProducer(string endpointName)

Parameters

Type	Name	Description
string	endpointName	The target endpoint name (or friendly name).

Returns

Type	Description
KafkaTransactionalProducer	The IProducer for the specified endpoint.

InstantiateConsumer(KafkaConsumerEndpoint, IBrokerBehaviorsProvider<IConsumerBehavior>, IServiceProvider)

Returns a new instance of IConsumer to subscribe to the specified endpoint.

Declaration

protected override IConsumer InstantiateConsumer(KafkaConsumerEndpoint endpoint, IBrokerBehaviorsProvider<IConsumerBehavior> behaviorsProvider, IServiceProvider serviceProvider)

Parameters

Type	Name	Description
KafkaConsumerEndpoint	endpoint	The endpoint.
IBrokerBehaviorsProvider<IConsumerBehavior>	behaviorsProvider	The IBrokerBehaviorsProvider<TBehavior>.
IServiceProvider	serviceProvider	The IServiceProvider instance to be used to resolve the needed types or to be forwarded to the consumer.

Returns

Type	Description
IConsumer	The instantiated IConsumer.

Overrides

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.InstantiateConsumer(KafkaConsumerEndpoint, IBrokerBehaviorsProvider<IConsumerBehavior>, IServiceProvider)

InstantiateProducer(KafkaProducerEndpoint, IBrokerBehaviorsProvider<IProducerBehavior>, IServiceProvider)

Returns a new instance of IProducer to publish to the specified endpoint. The returned instance will be cached and reused for the same endpoint.

Declaration

protected override IProducer InstantiateProducer(KafkaProducerEndpoint endpoint, IBrokerBehaviorsProvider<IProducerBehavior> behaviorsProvider, IServiceProvider serviceProvider)

Parameters

Type	Name	Description
KafkaProducerEndpoint	endpoint	The endpoint.
IBrokerBehaviorsProvider<IProducerBehavior>	behaviorsProvider	The IBrokerBehaviorsProvider<TBehavior>.
IServiceProvider	serviceProvider	The IServiceProvider instance to be used to resolve the needed types or to be forwarded to the consumer.

Returns

Type	Description
IProducer	The instantiated IProducer.

Overrides

Broker<KafkaProducerEndpoint, KafkaConsumerEndpoint>.InstantiateProducer(KafkaProducerEndpoint, IBrokerBehaviorsProvider<IProducerBehavior>, IServiceProvider)

Implements

IBroker

IDisposable