# ServiceBusSource {{< rawhtml >}}

Class ServiceBusSource<TOutput>

A data flow source for Azure service bus. This will receive messages from the source for furhter processing. MaxMessages to adjust the number of messages fetched per request. Adjust the ReceiverOptions to your needs - the default receive mode is PeekLock. The source will read until either the MaxWaitTime has been reached during a request or if no new messages can be read from the source.

Inheritance
object
LoggableTask
DataFlowComponent
DataFlowSource<TOutput>
DataFlowExecutableSource<TOutput>
ServiceBusSource<TOutput>
ServiceBusSource
Implements
IDataFlowExecutableSource<TOutput>
IDataFlowSource<TOutput>
IDataFlowExecutableSource
IDataFlowSource
IDataFlowComponent
ILoggableTask
Inherited Members
DataFlowExecutableSource<TOutput>.Limit
DataFlowExecutableSource<TOutput>.ProgressCountIsInLimit
DataFlowExecutableSource<TOutput>.ProgressCountIsExceedingLimit
DataFlowExecutableSource<TOutput>.SourceBlock
DataFlowExecutableSource<TOutput>.Buffer
DataFlowExecutableSource<TOutput>.SourceTask
DataFlowExecutableSource<TOutput>.CompleteManually
DataFlowExecutableSource<TOutput>.InitComponent()
DataFlowExecutableSource<TOutput>.CompleteBuffer()
DataFlowExecutableSource<TOutput>.FaultBuffer(Exception)
DataFlowExecutableSource<TOutput>.Execute()
DataFlowExecutableSource<TOutput>.Execute(CancellationToken)
DataFlowExecutableSource<TOutput>.ExecuteAsync()
DataFlowExecutableSource<TOutput>.ExecuteAsync(CancellationToken)
DataFlowExecutableSource<TOutput>.StartAsync(CancellationToken?)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
DataFlowComponent.MaxBufferSize
DataFlowComponent.Predecessors
DataFlowComponent.Successors
DataFlowComponent.Completion
DataFlowComponent.BufferCancellationSource
DataFlowComponent.BufferCancellationToken
DataFlowComponent.WasComponentInitialized
DataFlowComponent.IsReadyForProcessing
DataFlowComponent.SetParentComponent(DataFlowComponent)
DataFlowComponent.LinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.InternalLinkTo<T>(IDataFlowDestination, object, object)
DataFlowComponent.AddComplementVoidLinkToOtherTargets(Func<Type, IDataFlowDestination>, Delegate)
DataFlowComponent.ResetComponent()
DataFlowComponent.InitBufferObjects(CancellationToken?)
DataFlowComponent.Reset()
DataFlowComponent.PrepareParameterForCheck()
DataFlowComponent.OnInitialization
DataFlowComponent.OnCompletion
DataFlowComponent.OnException
DataFlowComponent.CompleteOrFaultBufferOnPredecessorCompletion(Task)
DataFlowComponent.Exception
DataFlowComponent.ErrorSource
DataFlowComponent.CancelBufferAndThrowOperationCanceledException()
DataFlowComponent.InternalLinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.ThrowOrRedirectError(Exception, string, string)
DataFlowComponent.ThrowErrorAndFaultNetwork(Exception, string)
DataFlowComponent.CancelComponent()
DataFlowComponent.ErrorCount
DataFlowComponent.ProgressCount
DataFlowComponent.OnProgress
DataFlowComponent.ExecutionStartTime
DataFlowComponent.ExecutionEndTime
DataFlowComponent.Tag
DataFlowComponent.LoggingStartOnce()
DataFlowComponent.LoggingFinishOnce()
DataFlowComponent.LogProgressBatch_AfterThrowOrRedirectError(int)
DataFlowComponent.LogProgress_AfterThrowOrRedirectError()
LoggableTask.TaskType
LoggableTask.TaskName
LoggableTask.DisableLogging
LoggableTask.LogThreshold
LoggableTask.TaskHash
LoggableTask.LogInstance
LoggableTask.ParentTask
LoggableTask.LogTrace(string, params object[])
LoggableTask.LogDebug(string, params object[])
LoggableTask.LogInfo(string, params object[])
LoggableTask.LogInfoOrDebug(string, params object[])
LoggableTask.LogWarn(string, params object[])
LoggableTask.LogError(string, params object[])
LoggableTask.LogFatal(string, params object[])
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ETLBox.Azure.ServiceBus
Assembly: ETLBox.Azure.ServiceBus.dll
Syntax
{{< /rawhtml >}} ```C# public class ServiceBusSource : DataFlowExecutableSource, IDataFlowExecutableSource, IDataFlowSource, IDataFlowExecutableSource, IDataFlowSource, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}
Type Parameters
Name Description
TOutput

Type of outgoing data.

Constructors

ServiceBusSource()

Declaration
{{< /rawhtml >}} ```C# public ServiceBusSource() ``` {{< rawhtml >}}

Properties

Client

The client that owns the connection and can be used to create senders and receivers.
Automatically created if you provide a ConnectionString, unless you provide your own instance here.

Declaration
{{< /rawhtml >}} ```C# public ServiceBusClient Client { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ServiceBusClient

ClientOptions

The client options used when instantiating a new client.

Declaration
{{< /rawhtml >}} ```C# public ServiceBusClientOptions ClientOptions { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ServiceBusClientOptions

ConnectionString

If you provide a namespace connection string, this component will create new ServiceBusClient object to communicate with the Azure Service Bus. If you need to reuse an existing Client object, you can provide your own via the Client property.

Declaration
{{< /rawhtml >}} ```C# public string ConnectionString { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
string

ContinueReceiving

Function that determines if the next message should be retrieved, based on the last retrieved message.

Declaration
{{< /rawhtml >}} ```C# public Func, bool> ContinueReceiving { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<IReadOnlyList<ServiceBusReceivedMessage>, bool>

MaxMessages

The maximum number of messages that will be received per request. This method doesn't guarantee to return exact MaxMessages messages, even if there are MaxMessages messages available in the queue or topic. Default is 1.

Declaration
{{< /rawhtml >}} ```C# public int MaxMessages { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
int

MaxWaitTime

The maximum wait time for the next message. Set this to null if you want to wait indefinitely. If the wait time is has been reached, the Service Bus Source will send the already received message into the data flow.

Declaration
{{< /rawhtml >}} ```C# public TimeSpan? MaxWaitTime { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
TimeSpan?

QueueOrTopicName

Name of the destination queue or topic

Declaration
{{< /rawhtml >}} ```C# public string QueueOrTopicName { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
string

Receiver

The receiver used to read messages to the queue. Automatically created from the Client.

Declaration
{{< /rawhtml >}} ```C# public ServiceBusReceiver Receiver { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ServiceBusReceiver

ReceiverOptions

The reciver options used when instantiating a new reciver.

Declaration
{{< /rawhtml >}} ```C# public ServiceBusReceiverOptions ReceiverOptions { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
ServiceBusReceiverOptions

SubscriptionName

Optional: The subscription name

Declaration
{{< /rawhtml >}} ```C# public string SubscriptionName { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
string

Methods

CheckParameter()

Declaration
{{< /rawhtml >}} ```C# protected override void CheckParameter() ``` {{< rawhtml >}}
Overrides

CleanUpOnFaulted(Exception)

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnFaulted(Exception e) ``` {{< rawhtml >}}
Parameters
Type Name Description
Exception e
Overrides

CleanUpOnSuccess()

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnSuccess() ``` {{< rawhtml >}}
Overrides

InitCheckedParameter()

Declaration
{{< /rawhtml >}} ```C# protected override void InitCheckedParameter() ``` {{< rawhtml >}}
Overrides

OnExecutionDoAsyncWork()

Declaration
{{< /rawhtml >}} ```C# protected override void OnExecutionDoAsyncWork() ``` {{< rawhtml >}}
Overrides

Implements

{{< /rawhtml >}}