Other minor improvements

This commit is contained in:
Endre Sándor Varga 2015-07-09 11:49:32 +02:00
parent aa2596f088
commit b5a813f766
4 changed files with 20 additions and 4 deletions

View file

@ -37,8 +37,8 @@ stream if there is demand from downstream, otherwise they will be buffered until
demand is received.
Depending on the defined :class:`OverflowStrategy` it might drop elements if there is no space
available in the buffer. The strategy :class:`OverflowStrategy.backpressure()` is not supported
for this Source type, you should consider using ActorPublisher if you want a backpressured
available in the buffer. The strategy ``OverflowStrategy.backpressure()`` is not supported
for this Source type, you should consider using ``ActorPublisher`` if you want a backpressured
actor interface.
The stream can be completed successfully by sending ``akka.actor.PoisonPill`` or

View file

@ -32,8 +32,8 @@ stream if there is demand from downstream, otherwise they will be buffered until
demand is received.
Depending on the defined :class:`OverflowStrategy` it might drop elements if there is no space
available in the buffer. The strategy :class:`OverflowStrategy.backpressure` is not supported
for this Source type, you should consider using ActorPublisher if you want a backpressured
available in the buffer. The strategy ``OverflowStrategy.backpressure`` is not supported
for this Source type, you should consider using ``ActorPublisher`` if you want a backpressured
actor interface.
The stream can be completed successfully by sending ``akka.actor.PoisonPill`` or

View file

@ -100,6 +100,10 @@ class Tcp(system: ExtendedActorSystem) extends akka.actor.Extension {
/**
* Creates a [[Tcp.ServerBinding]] instance which represents a prospective TCP server binding on the given `endpoint`.
*
* Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing
* [[akka.stream.scaladsl.RunnableGraph]] the server is not immediately available. Only after the materialized future
* completes is the server ready to accept client connections.
*
* @param interface The interface to listen on
* @param port The port to listen on
* @param backlog Controls the size of the connection backlog
@ -127,6 +131,10 @@ class Tcp(system: ExtendedActorSystem) extends akka.actor.Extension {
/**
* Creates a [[Tcp.ServerBinding]] without specifying options.
* It represents a prospective TCP server binding on the given `endpoint`.
*
* Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing
* [[akka.stream.scaladsl.RunnableGraph]] the server is not immediately available. Only after the materialized future
* completes is the server ready to accept client connections.
*/
def bind(interface: String, port: Int): Source[IncomingConnection, Future[ServerBinding]] =
Source.adapt(delegate.bind(interface, port)

View file

@ -119,6 +119,10 @@ class Tcp(system: ExtendedActorSystem) extends akka.actor.Extension {
/**
* Creates a [[Tcp.ServerBinding]] instance which represents a prospective TCP server binding on the given `endpoint`.
*
* Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing
* [[akka.stream.scaladsl.RunnableGraph]] the server is not immediately available. Only after the materialized future
* completes is the server ready to accept client connections.
*
* @param interface The interface to listen on
* @param port The port to listen on
* @param backlog Controls the size of the connection backlog
@ -147,6 +151,10 @@ class Tcp(system: ExtendedActorSystem) extends akka.actor.Extension {
* Creates a [[Tcp.ServerBinding]] instance which represents a prospective TCP server binding on the given `endpoint`
* handling the incoming connections using the provided Flow.
*
* Please note that the startup of the server is asynchronous, i.e. after materializing the enclosing
* [[akka.stream.scaladsl.RunnableGraph]] the server is not immediately available. Only after the returned future
* completes is the server ready to accept client connections.
*
* @param handler A Flow that represents the server logic
* @param interface The interface to listen on
* @param port The port to listen on