Type Members

1.  sealed abstract class Authentication extends AnyRef

   Use sealed for closed class hierarchies.

   Use sealed for closed class hierarchies. abstract class instead of trait for visibility inside companion object from Java.

2.  final class ReferenceReadResult extends AnyRef

   Use "Read" in message data types to signify that the message was read from outside.

   Use "Read" in message data types to signify that the message was read from outside.

   The constructor is INTERNAL API, but you may construct instances for testing by using pekko.stream.connectors.reference.testkit.MessageFactory.

3.  final class ReferenceResourceValue extends Attribute
4.  final class ReferenceWriteMessage extends AnyRef

   Use "Write" in message data types to signify that the messages is to be written to outside.

5.  final class ReferenceWriteResult extends AnyRef

   The result returned by the flow for each ReferenceWriteMessage.

   The result returned by the flow for each ReferenceWriteMessage.

   As this class is not meant to be instantiated outside of this connector the constructor is marked as INTERNAL API.

   The constructor is INTERNAL API, but you may construct instances for testing by using pekko.stream.connectors.reference.testkit.MessageFactory.

6.  final class Resource extends AnyRef

   Some connectors might require an external resource that is used in the Source, Flow and/or Sink factories.

   Some connectors might require an external resource that is used in the Source, Flow and/or Sink factories.

   For example dynamodb connector needs a DynamoClient to create Sources and Flows. Another example is Google Pub Sub gRPC connector that uses Grpc Publishers and Subscribers to create Sources and Sinks. Another connector, Pekko Connectors Kafka, uses an actor that can be shared across different streams.

   If your connector uses such a resource and it is possible to reuse that resource across different Pekko Stream operator factories, put that resource to a separate class like below.

7.  final class ResourceExt extends Extension

   In order to minimise the user facing API, the resource lifetime can be managed by an Pekko Extension.

   In order to minimise the user facing API, the resource lifetime can be managed by an Pekko Extension. In that case Pekko Extension will make sure that there is only one instance of the resource instantiated per Actor System.

8.  final class ResourceSettings extends AnyRef

   Settings required for the Resource should be extracted to a separate class.

9.  final class SourceSettings extends AnyRef

   Settings class constructor is private and not exposed as API.

   Settings class constructor is private and not exposed as API. Adding or removing arguments to methods with default values is not binary compatible. However, since the constructor is private, it will be possible to add or remove attributes without introducing binary incompatibilities.