raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

=str Add scaladoc to Graph (#31141)

Browse source
This commit is contained in:
kerr 2022-02-21 21:08:36 +08:00 • committed by GitHub
parent 0c46294e96
commit 03ee474f49
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
akka-stream/src/main/scala/akka/stream/Graph.scala
View file

@ -21,6 +21,7 @@ trait Graph[+S <: Shape, +M] {
* Type-level accessor for the shape parameter of this graph. * Type-level accessor for the shape parameter of this graph.
*/ */
type Shape = S @uncheckedVariance type Shape = S @uncheckedVariance
/** /**
* The shape of a graph is all that is externally visible: its inlets and outlets. * The shape of a graph is all that is externally visible: its inlets and outlets.
*/ */
@ -33,8 +34,17 @@ trait Graph[+S <: Shape, +M] {
*/ */
private[stream] def traversalBuilder: TraversalBuilder private[stream] def traversalBuilder: TraversalBuilder
/**
* Replace the attributes of this [[Flow]] with the given ones. If this Flow is a composite
* of multiple graphs, new attributes on the composite will be less specific than attributes
* set directly on the individual graphs of the composite.
*/
def withAttributes(attr: Attributes): Graph[S, M] def withAttributes(attr: Attributes): Graph[S, M]
/**
* Specifies the name of the Graph.
* If the name is null or empty the name is ignored, i.e. [[#none]] is returned.
*/
def named(name: String): Graph[S, M] = addAttributes(Attributes.name(name)) def named(name: String): Graph[S, M] = addAttributes(Attributes.name(name))
/** /**
@ -47,7 +57,7 @@ trait Graph[+S <: Shape, +M] {
* *
* @param dispatcher Run the graph on this dispatcher * @param dispatcher Run the graph on this dispatcher
*/ */
def async(dispatcher: String) = def async(dispatcher: String): Graph[S, M] =
addAttributes(Attributes.asyncBoundary and ActorAttributes.dispatcher(dispatcher)) addAttributes(Attributes.asyncBoundary and ActorAttributes.dispatcher(dispatcher))
/** /**
@ -56,7 +66,7 @@ trait Graph[+S <: Shape, +M] {
* @param dispatcher Run the graph on this dispatcher * @param dispatcher Run the graph on this dispatcher
* @param inputBufferSize Set the input buffer to this size for the graph * @param inputBufferSize Set the input buffer to this size for the graph
*/ */
def async(dispatcher: String, inputBufferSize: Int) = def async(dispatcher: String, inputBufferSize: Int): Graph[S, M] =
addAttributes( addAttributes(
Attributes.asyncBoundary and ActorAttributes.dispatcher(dispatcher) Attributes.asyncBoundary and ActorAttributes.dispatcher(dispatcher)
and Attributes.inputBuffer(inputBufferSize, inputBufferSize)) and Attributes.inputBuffer(inputBufferSize, inputBufferSize))