Class RabbitAdmin

Namespace

Steeltoe.Messaging.RabbitMQ.Core

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 RabbitAdmin : IRabbitAdmin, IServiceNameAware, IConnectionListener

Inheritance

object

RabbitAdmin

Implements

IRabbitAdmin

IServiceNameAware

IConnectionListener

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RabbitAdmin(IApplicationContext, IConnectionFactory, ILogger)

[ActivatorUtilitiesConstructor]
public RabbitAdmin(IApplicationContext applicationContext, IConnectionFactory connectionFactory, ILogger logger = null)

Parameters

applicationContext IApplicationContext

connectionFactory IConnectionFactory

logger ILogger

RabbitAdmin(IConnectionFactory, ILogger)

public RabbitAdmin(IConnectionFactory connectionFactory, ILogger logger = null)

Parameters

connectionFactory IConnectionFactory

logger ILogger

RabbitAdmin(RabbitTemplate, ILogger)

public RabbitAdmin(RabbitTemplate template, ILogger logger = null)

Parameters

template RabbitTemplate

logger ILogger

Fields

DEFAULT_SERVICE_NAME

public const string DEFAULT_SERVICE_NAME = "rabbitAdmin"

Field Value

string

QUEUE_CONSUMER_COUNT

public const string QUEUE_CONSUMER_COUNT = "QUEUE_CONSUMER_COUNT"

Field Value

string

QUEUE_MESSAGE_COUNT

public const string QUEUE_MESSAGE_COUNT = "QUEUE_MESSAGE_COUNT"

Field Value

string

QUEUE_NAME

public const string QUEUE_NAME = "QUEUE_NAME"

Field Value

string

Properties

ApplicationContext

public IApplicationContext ApplicationContext { get; set; }

Property Value

IApplicationContext

AutoStartup

public bool AutoStartup { get; set; }

Property Value

bool

ConnectionFactory

public IConnectionFactory ConnectionFactory { get; set; }

Property Value

IConnectionFactory

ExplicitDeclarationsOnly

public bool ExplicitDeclarationsOnly { get; set; }

Property Value

bool

IgnoreDeclarationExceptions

public bool IgnoreDeclarationExceptions { get; set; }

Property Value

bool

IsAutoStartup

public bool IsAutoStartup { get; set; }

Property Value

bool

IsRunning

public bool IsRunning { get; }

Property Value

bool

LastDeclarationExceptionEvent

public DeclarationExceptionEvent LastDeclarationExceptionEvent { get; }

Property Value

DeclarationExceptionEvent

RabbitTemplate

public RabbitTemplate RabbitTemplate { get; }

Property Value

RabbitTemplate

RetryDisabled

public bool RetryDisabled { get; set; }

Property Value

bool

RetryTemplate

public RetryTemplate RetryTemplate { get; set; }

Property Value

RetryTemplate

ServiceName

public string ServiceName { get; set; }

Property Value

string

Methods

DeclareBinding(IBinding)

public void DeclareBinding(IBinding binding)

Parameters

binding IBinding

DeclareExchange(IExchange)

public void DeclareExchange(IExchange exchange)

Parameters

exchange IExchange

DeclareQueue()

public IQueue DeclareQueue()

Returns

IQueue

DeclareQueue(IQueue)

public string DeclareQueue(IQueue queue)

Parameters

queue IQueue

Returns

string

DeleteExchange(string)

public bool DeleteExchange(string exchangeName)

Parameters

exchangeName string

Returns

bool

DeleteQueue(string)

public bool DeleteQueue(string queueName)

Parameters

queueName string

Returns

bool

DeleteQueue(string, bool, bool)

public void DeleteQueue(string queueName, bool unused, bool empty)

Parameters

queueName string

unused bool

empty bool

GetQueueInfo(string)

public QueueInformation GetQueueInfo(string queueName)

Parameters

queueName string

Returns

QueueInformation

GetQueueProperties(string)

public Dictionary<string, object> GetQueueProperties(string queueName)

Parameters

queueName string

Returns

Dictionary<string, object>

Initialize()

public void Initialize()

OnClose(IConnection)

Called when connection is closed

public void OnClose(IConnection connection)

Parameters

connection IConnection

the connection

OnCreate(IConnection)

Called when a new connection is established

public void OnCreate(IConnection connection)

Parameters

connection IConnection

the connection

OnShutDown(ShutdownEventArgs)

Called when connection is forced to close

public void OnShutDown(ShutdownEventArgs args)

Parameters

args ShutdownEventArgs

the event

PurgeQueue(string)

public uint PurgeQueue(string queueName)

Parameters

queueName string

Returns

uint

PurgeQueue(string, bool)

public void PurgeQueue(string queueName, bool noWait)

Parameters

queueName string

noWait bool

RemoveBinding(IBinding)

public void RemoveBinding(IBinding binding)

Parameters

binding IBinding