Class Broker<TProducerEndpoint, TConsumerEndpoint>

The base class for all IBroker implementations.

Inheritance

System.Object

Broker<TProducerEndpoint, TConsumerEndpoint>

KafkaBroker

MqttBroker

RabbitBroker

TransactionalOutboxBroker

Implements

IBroker

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Silverback.Messaging.Broker

Assembly: Silverback.Integration.dll

Syntax

public abstract class Broker<TProducerEndpoint, TConsumerEndpoint> : IBroker, IDisposable where TProducerEndpoint : IProducerEndpoint where TConsumerEndpoint : IConsumerEndpoint

Type Parameters

Name	Description
TProducerEndpoint	The type of the IProducerEndpoint that is being handled by this broker implementation.
TConsumerEndpoint	The type of the IConsumerEndpoint that is being handled by this broker implementation.

Constructors

Broker(IServiceProvider)

Initializes a new instance of the Broker<TProducerEndpoint, TConsumerEndpoint> class.

Declaration

protected Broker(IServiceProvider serviceProvider)

Parameters

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

Properties

ConsumerEndpointType

Declaration

public Type ConsumerEndpointType { get; }

Property Value

Type	Description
System.Type

Consumers

Declaration

public IReadOnlyList<IConsumer> Consumers { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<IConsumer>

IsConnected

Declaration

public bool IsConnected { get; }

Property Value

Type	Description
System.Boolean

ProducerEndpointType

Declaration

public Type ProducerEndpointType { get; }

Property Value

Type	Description
System.Type

Producers

Declaration

public IReadOnlyList<IProducer> Producers { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<IProducer>

Methods

AddConsumer(IConsumerEndpoint)

Declaration

public virtual IConsumer AddConsumer(IConsumerEndpoint endpoint)

Parameters

Type	Name	Description
IConsumerEndpoint	endpoint

Returns

Type	Description
IConsumer

ConnectAsync()

Declaration

public async Task ConnectAsync()

Returns

Type	Description
System.Threading.Tasks.Task

ConnectAsync(IReadOnlyCollection<IProducer>, IReadOnlyCollection<IConsumer>)

Connects all the consumers and starts consuming.

Declaration

protected virtual async Task ConnectAsync(IReadOnlyCollection<IProducer> producers, IReadOnlyCollection<IConsumer> consumers)

Parameters

Type	Name	Description
System.Collections.Generic.IReadOnlyCollection<IProducer>	producers	The producers to be connected.
System.Collections.Generic.IReadOnlyCollection<IConsumer>	consumers	The consumers to be connected and started.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

DisconnectAsync()

Declaration

public async Task DisconnectAsync()

Returns

Type	Description
System.Threading.Tasks.Task

DisconnectAsync(IReadOnlyCollection<IProducer>, IReadOnlyCollection<IConsumer>)

Disconnects all the consumers and stops consuming.

Declaration

protected virtual async Task DisconnectAsync(IReadOnlyCollection<IProducer> producers, IReadOnlyCollection<IConsumer> consumers)

Parameters

Type	Name	Description
System.Collections.Generic.IReadOnlyCollection<IProducer>	producers	The producers to be disconnected.
System.Collections.Generic.IReadOnlyCollection<IConsumer>	consumers	The consumers to be stopped and disconnected.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Dispose()

Declaration

public void Dispose()

Dispose(Boolean)

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

Declaration

protected virtual void Dispose(bool disposing)

Parameters

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

GetProducer(IProducerEndpoint)

Declaration

public virtual IProducer GetProducer(IProducerEndpoint endpoint)

Parameters

Type	Name	Description
IProducerEndpoint	endpoint

Returns

Type	Description
IProducer

GetProducer(String)

Declaration

public virtual IProducer GetProducer(string endpointName)

Parameters

Type	Name	Description
System.String	endpointName

Returns

Type	Description
IProducer

InstantiateConsumer(TConsumerEndpoint, IBrokerBehaviorsProvider<IConsumerBehavior>, IServiceProvider)

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

Declaration

protected abstract IConsumer InstantiateConsumer(TConsumerEndpoint endpoint, IBrokerBehaviorsProvider<IConsumerBehavior> behaviorsProvider, IServiceProvider serviceProvider)

Parameters

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

Returns

Type	Description
IConsumer	The instantiated IConsumer.

InstantiateProducer(TProducerEndpoint, 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 abstract IProducer InstantiateProducer(TProducerEndpoint endpoint, IBrokerBehaviorsProvider<IProducerBehavior> behaviorsProvider, IServiceProvider serviceProvider)

Parameters

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

Returns

Type	Description
IProducer	The instantiated IProducer.

Implements

IBroker

System.IDisposable