Class RabbitListenerEndpointRegistry

Namespace

Steeltoe.Messaging.RabbitMQ.Listener

Assembly

Steeltoe.Messaging.RabbitMQ.dll

[Obsolete("This feature will be removed in the next major version. See https://steeltoe.io/docs/v3/obsolete for details.")]
public class RabbitListenerEndpointRegistry : IRabbitListenerEndpointRegistry, ISmartLifecycle, ILifecycle, IPhased, IDisposable, IServiceNameAware

Inheritance

object

RabbitListenerEndpointRegistry

Implements

IRabbitListenerEndpointRegistry

ISmartLifecycle

ILifecycle

IPhased

IDisposable

IServiceNameAware

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RabbitListenerEndpointRegistry(IApplicationContext, ILogger)

public RabbitListenerEndpointRegistry(IApplicationContext applicationContext, ILogger logger = null)

Parameters

applicationContext IApplicationContext

logger ILogger

Fields

DEFAULT_SERVICE_NAME

public const string DEFAULT_SERVICE_NAME = "RabbitListenerEndpointRegistry"

Field Value

string

Properties

ApplicationContext

public IApplicationContext ApplicationContext { get; set; }

Property Value

IApplicationContext

IsAutoStartup

Gets a value indicating whether the auto startup is set for this object

public bool IsAutoStartup { get; }

Property Value

bool

IsRunning

Gets a value indicating whether gets a value indicating if its running

public bool IsRunning { get; }

Property Value

bool

Phase

Gets the phase of this object

public int Phase { get; set; }

Property Value

int

ServiceName

public string ServiceName { get; set; }

Property Value

string

Methods

CreateListenerContainer(IRabbitListenerEndpoint, IRabbitListenerContainerFactory)

protected IMessageListenerContainer CreateListenerContainer(IRabbitListenerEndpoint endpoint, IRabbitListenerContainerFactory factory)

Parameters

endpoint IRabbitListenerEndpoint

factory IRabbitListenerContainerFactory

Returns

IMessageListenerContainer

Dispose()

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

public void Dispose()

GetListenerContainer(string)

public IMessageListenerContainer GetListenerContainer(string id)

Parameters

id string

Returns

IMessageListenerContainer

GetListenerContainerIds()

public ISet<string> GetListenerContainerIds()

Returns

ISet<string>

GetListenerContainers()

public ICollection<IMessageListenerContainer> GetListenerContainers()

Returns

ICollection<IMessageListenerContainer>

RegisterListenerContainer(IRabbitListenerEndpoint, IRabbitListenerContainerFactory)

public void RegisterListenerContainer(IRabbitListenerEndpoint endpoint, IRabbitListenerContainerFactory factory)

Parameters

endpoint IRabbitListenerEndpoint

factory IRabbitListenerContainerFactory

RegisterListenerContainer(IRabbitListenerEndpoint, IRabbitListenerContainerFactory, bool)

public void RegisterListenerContainer(IRabbitListenerEndpoint endpoint, IRabbitListenerContainerFactory factory, bool startImmediately)

Parameters

endpoint IRabbitListenerEndpoint

factory IRabbitListenerContainerFactory

startImmediately bool

Start()

Start this component

public Task Start()

Returns

Task

a task to signal completion

Stop()

Stop this component

public Task Stop()

Returns

Task

a task to signal completion

Stop(Action)

Stop the component and issue the callback when complete

public Task Stop(Action callback)

Parameters

callback Action

the callback action to invoke when complete

Returns

Task

a task for completion

UnregisterListenerContainer(string)

public IMessageListenerContainer UnregisterListenerContainer(string id)

Parameters

id string

Returns

IMessageListenerContainer