Click or drag to resize
Akka.NETBroadcastHub Class
A BroadcastHub is a special streaming hub that is able to broadcast streamed elements to a dynamic set of consumers. It consists of two parts, a SinkTIn, TMat and a SourceTOut, TMat. The SinkTIn, TMat broadcasts elements from a producer to the actually live consumers it has. Once the producer has been materialized, the SinkTIn, TMat it feeds into returns a materialized value which is the corresponding SourceTOut, TMat. This SourceTOut, TMat can be materialized arbitrary many times, where each of the new materializations will receive their elements from the original SinkTIn, TMat.
Inheritance Hierarchy
SystemObject
  Akka.Streams.DslBroadcastHub

Namespace:  Akka.Streams.Dsl
Assembly:  Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax
Copy
public class BroadcastHub

The BroadcastHub type exposes the following members.

Constructors
  NameDescription
Public methodBroadcastHub
Initializes a new instance of the BroadcastHub class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberSinkT
Creates a SinkTIn, TMat that receives elements from its upstream producer and broadcasts them to a dynamic set of consumers. After the SinkTIn, TMat returned by this method is materialized, it returns a SourceTOut, TMat as materialized value. This SourceTOut, TMat can be materialized arbitrary many times and each materialization will receive the broadcast elements from the original SinkTIn, TMat. Every new materialization of the SinkTIn, TMat results in a new, independent hub, which materializes to its own SourceTOut, TMat for consuming the SinkTIn, TMat of that materialization. If the original SinkTIn, TMat is failed, then the failure is immediately propagated to all of its materialized SourceTOut, TMats (possibly jumping over already buffered elements). If the original SinkTIn, TMat is completed, then all corresponding SourceTOut, TMats are completed. Both failure and normal completion is "remembered" and later materializations of the SourceTOut, TMat will see the same (failure or completion) state. SourceTOut, TMats that are cancelled are simply removed from the dynamic set of consumers.
Public methodStatic memberSinkT(Int32)
Creates a SinkTIn, TMat that receives elements from its upstream producer and broadcasts them to a dynamic set of consumers. After the SinkTIn, TMat returned by this method is materialized, it returns a SourceTOut, TMat as materialized value. This SourceTOut, TMat can be materialized arbitrary many times and each materialization will receive the broadcast elements form the original SinkTIn, TMat. Every new materialization of the SinkTIn, TMat results in a new, independent hub, which materializes to its own SourceTOut, TMat for consuming the SinkTIn, TMat of that materialization. If the original SinkTIn, TMat is failed, then the failure is immediately propagated to all of its materialized SourceTOut, TMats (possibly jumping over already buffered elements). If the original SinkTIn, TMat is completed, then all corresponding SourceTOut, TMats are completed. Both failure and normal completion is "remembered" and later materializations of the SourceTOut, TMat will see the same (failure or completion) state. SourceTOut, TMats that are cancelled are simply removed from the dynamic set of consumers.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
See Also