Interface IRecurringMessageScheduler

Namespace

MassTransit

Assembly

MassTransit.Abstractions.dll

A message scheduler is able to schedule a message for delivery.

public interface IRecurringMessageScheduler

Methods

CancelScheduledRecurringSend(string, string)

Cancel a scheduled message by TokenId

Task CancelScheduledRecurringSend(string scheduleId, string scheduleGroup)

Parameters

scheduleId string

The scheduleId from the recurring schedule

scheduleGroup string

The scheduleGroup from the recurring schedule

Returns

Task

ScheduleRecurringSend(Uri, RecurringSchedule, object, IPipe<SendContext>, CancellationToken)

Sends an object as a message, using the message type specified. If the object cannot be cast to the specified message type, an exception will be thrown.

Task<ScheduledRecurringMessage> ScheduleRecurringSend(Uri destinationAddress, RecurringSchedule schedule, object message, IPipe<SendContext> pipe, CancellationToken cancellationToken = default)

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

message object

The message object

pipe IPipe<SendContext>

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage>

The task which is completed once the Send is acknowledged by the broker

ScheduleRecurringSend(Uri, RecurringSchedule, object, CancellationToken)

Sends an object as a message, using the type of the message instance.

Task<ScheduledRecurringMessage> ScheduleRecurringSend(Uri destinationAddress, RecurringSchedule schedule, object message, CancellationToken cancellationToken = default)

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

message object

The message object

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage>

The task which is completed once the Send is acknowledged by the broker

ScheduleRecurringSend(Uri, RecurringSchedule, object, Type, IPipe<SendContext>, CancellationToken)

Sends an object as a message, using the message type specified. If the object cannot be cast to the specified message type, an exception will be thrown.

Task<ScheduledRecurringMessage> ScheduleRecurringSend(Uri destinationAddress, RecurringSchedule schedule, object message, Type messageType, IPipe<SendContext> pipe, CancellationToken cancellationToken = default)

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

message object

The message object

messageType Type

The type of the message (use message.GetType() if desired)

pipe IPipe<SendContext>

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage>

The task which is completed once the Send is acknowledged by the broker

ScheduleRecurringSend(Uri, RecurringSchedule, object, Type, CancellationToken)

Sends an object as a message, using the message type specified. If the object cannot be cast to the specified message type, an exception will be thrown.

Task<ScheduledRecurringMessage> ScheduleRecurringSend(Uri destinationAddress, RecurringSchedule schedule, object message, Type messageType, CancellationToken cancellationToken = default)

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

message object

The message object

messageType Type

The type of the message (use message.GetType() if desired)

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage>

The task which is completed once the Send is acknowledged by the broker

ScheduleRecurringSend<T>(Uri, RecurringSchedule, object, IPipe<SendContext<T>>, CancellationToken)

Sends an interface message, initializing the properties of the interface using the anonymous object specified

Task<ScheduledRecurringMessage<T>> ScheduleRecurringSend<T>(Uri destinationAddress, RecurringSchedule schedule, object values, IPipe<SendContext<T>> pipe, CancellationToken cancellationToken = default) where T : class

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

values object

The property values to initialize on the interface

pipe IPipe<SendContext<T>>

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage<T>>

The task which is completed once the Send is acknowledged by the broker

Type Parameters

T

The interface type to send

ScheduleRecurringSend<T>(Uri, RecurringSchedule, object, IPipe<SendContext>, CancellationToken)

Sends an interface message, initializing the properties of the interface using the anonymous object specified

Task<ScheduledRecurringMessage<T>> ScheduleRecurringSend<T>(Uri destinationAddress, RecurringSchedule schedule, object values, IPipe<SendContext> pipe, CancellationToken cancellationToken = default) where T : class

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

values object

The property values to initialize on the interface

pipe IPipe<SendContext>

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage<T>>

The task which is completed once the Send is acknowledged by the broker

Type Parameters

T

The interface type to send

ScheduleRecurringSend<T>(Uri, RecurringSchedule, object, CancellationToken)

Sends an interface message, initializing the properties of the interface using the anonymous object specified

Task<ScheduledRecurringMessage<T>> ScheduleRecurringSend<T>(Uri destinationAddress, RecurringSchedule schedule, object values, CancellationToken cancellationToken = default) where T : class

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

values object

The property values to initialize on the interface

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage<T>>

The task which is completed once the Send is acknowledged by the broker

Type Parameters

T

The interface type to send

ScheduleRecurringSend<T>(Uri, RecurringSchedule, T, IPipe<SendContext<T>>, CancellationToken)

Send a message

Task<ScheduledRecurringMessage<T>> ScheduleRecurringSend<T>(Uri destinationAddress, RecurringSchedule schedule, T message, IPipe<SendContext<T>> pipe, CancellationToken cancellationToken = default) where T : class

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

message T

The message

pipe IPipe<SendContext<T>>

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage<T>>

The task which is completed once the Send is acknowledged by the broker

Type Parameters

T

The message type

ScheduleRecurringSend<T>(Uri, RecurringSchedule, T, IPipe<SendContext>, CancellationToken)

Send a message

Task<ScheduledRecurringMessage<T>> ScheduleRecurringSend<T>(Uri destinationAddress, RecurringSchedule schedule, T message, IPipe<SendContext> pipe, CancellationToken cancellationToken = default) where T : class

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

message T

The message

pipe IPipe<SendContext>

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage<T>>

The task which is completed once the Send is acknowledged by the broker

Type Parameters

T

The message type

ScheduleRecurringSend<T>(Uri, RecurringSchedule, T, CancellationToken)

Send a message

Task<ScheduledRecurringMessage<T>> ScheduleRecurringSend<T>(Uri destinationAddress, RecurringSchedule schedule, T message, CancellationToken cancellationToken = default) where T : class

Parameters

destinationAddress Uri

The destination address where the schedule message should be sent

schedule RecurringSchedule

The schedule for the message to be delivered

message T

The message

cancellationToken CancellationToken

Returns

Task<ScheduledRecurringMessage<T>>

The task which is completed once the Send is acknowledged by the broker

Type Parameters

T

The message type