Show / Hide Table of Contents

    Class QueueSource

    A Akka.Streams.Dsl.Source<TOut, TMat> for the Azure Storage Queue

    Inheritance
    Object
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>
    Akka.Streams.Stage.GraphStage<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>>
    QueueSource
    Implements
    Akka.Streams.Stage.IGraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>
    Akka.Streams.IGraph<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>
    Akka.Streams.IGraph<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>>
    Inherited Members
    Akka.Streams.Stage.GraphStage<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>>.CreateLogicAndMaterializedValue(Akka.Streams.Attributes)
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.WithAttributes(Akka.Streams.Attributes)
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.CreateLogicAndMaterializedValue(Akka.Streams.Attributes)
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.AddAttributes(Akka.Streams.Attributes)
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.Named(System.String)
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.Async()
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.InitialAttributes
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.Shape
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.Module
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Akka.Streams.Azure.StorageQueue
    Assembly: Akka.Streams.Azure.StorageQueue.dll
    Syntax
    public class QueueSource : GraphStage<SourceShape<QueueMessage>>, IGraphStageWithMaterializedValue<SourceShape<QueueMessage>, NotUsed>, IGraph<SourceShape<QueueMessage>, NotUsed>, IGraph<SourceShape<QueueMessage>>

    Constructors

    | Improve this Doc View Source

    QueueSource(QueueClient, Int32, Nullable<TimeSpan>, GetRequestOptions)

    Create a new instance of the QueueSource

    Declaration
    public QueueSource(QueueClient queue, int prefetchCount = 10, TimeSpan? pollInterval = default(TimeSpan? ), GetRequestOptions options = null)
    Parameters
    Type Name Description
    Azure.Storage.Queues.QueueClient queue

    The queue

    Int32 prefetchCount

    The number of messages that should be read from the queue at once

    Nullable<TimeSpan> pollInterval

    The interval in witch the queue should be polled if it is empty. Default = 10 seconds

    GetRequestOptions options

    The options for the Azure.Storage.Queues.QueueClient.ReceiveMessagesAsync call

    Properties

    | Improve this Doc View Source

    InitialAttributes

    Declaration
    protected override Attributes InitialAttributes { get; }
    Property Value
    Type Description
    Akka.Streams.Attributes
    Overrides
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.InitialAttributes
    | Improve this Doc View Source

    Out

    Declaration
    public Outlet<QueueMessage> Out { get; }
    Property Value
    Type Description
    Akka.Streams.Outlet<Azure.Storage.Queues.Models.QueueMessage>
    | Improve this Doc View Source

    Shape

    Declaration
    public override SourceShape<QueueMessage> Shape { get; }
    Property Value
    Type Description
    Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>
    Overrides
    Akka.Streams.Stage.GraphStageWithMaterializedValue<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>, Akka.NotUsed>.Shape

    Methods

    | Improve this Doc View Source

    Create(QueueClient, Int32, Nullable<TimeSpan>, GetRequestOptions)

    Creates a Akka.Streams.Dsl.Source<TOut, TMat> for the Azure Storage Queue

    Declaration
    public static Source<QueueMessage, NotUsed> Create(QueueClient queue, int prefetchCount = 10, TimeSpan? pollInterval = default(TimeSpan? ), GetRequestOptions options = null)
    Parameters
    Type Name Description
    Azure.Storage.Queues.QueueClient queue

    The queue

    Int32 prefetchCount

    The number of messages that should be read from the queue at once

    Nullable<TimeSpan> pollInterval

    The interval in witch the queue should be polled if it is empty. Default = 10 seconds

    GetRequestOptions options

    The options for the Azure.Storage.Queues.QueueClient.ReceiveMessagesAsync call

    Returns
    Type Description
    Akka.Streams.Dsl.Source<Azure.Storage.Queues.Models.QueueMessage, Akka.NotUsed>

    The Akka.Streams.Dsl.Source<TOut, TMat> for the Azure Storage Queue

    | Improve this Doc View Source

    CreateLogic(Attributes)

    Declaration
    protected override GraphStageLogic CreateLogic(Attributes inheritedAttributes)
    Parameters
    Type Name Description
    Akka.Streams.Attributes inheritedAttributes
    Returns
    Type Description
    Akka.Streams.Stage.GraphStageLogic
    Overrides
    Akka.Streams.Stage.GraphStage<Akka.Streams.SourceShape<Azure.Storage.Queues.Models.QueueMessage>>.CreateLogic(Akka.Streams.Attributes)

    Implements

    Akka.Streams.Stage.IGraphStageWithMaterializedValue<TShape, TMaterialized>
    Akka.Streams.IGraph<TShape, TMaterialized>
    Akka.Streams.IGraph<TShape>
    • Improve this Doc
    • View Source
    Back to top Copyright © 2013-2020 Akka.NET project
    Generated by DocFX