Trait

fs2.io.tcp

Socket

Related Docs: object Socket | package tcp

Permalink

trait Socket[F[_]] extends AnyRef

Provides the ability to read/write from a TCP socket in the effect F.

To construct a Socket, use the methods in the fs2.io.tcp package object.

Source
Socket.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Socket
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close: F[Unit]

    Permalink

    Closes the connection corresponding to this Socket.

  2. abstract def endOfInput: F[Unit]

    Permalink

    Indicates that this channel will not read more data.

    Indicates that this channel will not read more data. Causes End-Of-Stream be signalled to available.

  3. abstract def endOfOutput: F[Unit]

    Permalink

    Indicates to peer, we are done writing.

    Indicates to peer, we are done writing. *

  4. abstract def localAddress: F[SocketAddress]

    Permalink

    Asks for the local address of the socket.

  5. abstract def read(maxBytes: Int, timeout: Option[FiniteDuration] = None): F[Option[Chunk[Byte]]]

    Permalink

    Reads up to maxBytes from the peer.

    Reads up to maxBytes from the peer.

    Evaluates to None, if there are no more bytes to be read in future, due stream reached End-Of-Stream state before returning even single byte. Otherwise returns Some(bytes) with bytes that were ready to be read.

    If timeout is specified, then resulting F will evaluate to failure with java.nio.channels.InterruptedByTimeoutException if read was not satisfied in given timeout. Read is satisfied, when at least single Byte was received before timeout expires.

    This may return None, as well when end of stream has been reached before timeout expired and no data has been received.

  6. abstract def readN(numBytes: Int, timeout: Option[FiniteDuration] = None): F[Option[Chunk[Byte]]]

    Permalink

    Reads exactly numBytes from the peer in a single chunk.

    Reads exactly numBytes from the peer in a single chunk. If timeout is provided and no data arrives within the specified duration, then this results in failure with java.nio.channels.InterruptedByTimeoutException.

    When returned size of bytes is < numBytes that indicates end-of-stream has been reached.

  7. abstract def reads(maxBytes: Int, timeout: Option[FiniteDuration] = None): Stream[F, Byte]

    Permalink

    Reads stream of bytes from this socket with read semantics.

    Reads stream of bytes from this socket with read semantics. Terminates when eof is received. On timeout, this fails with java.nio.channels.InterruptedByTimeoutException.

  8. abstract def remoteAddress: F[SocketAddress]

    Permalink

    Asks for the remote address of the peer.

  9. abstract def write(bytes: Chunk[Byte], timeout: Option[FiniteDuration] = None): F[Unit]

    Permalink

    Writes bytes to the peer.

    Writes bytes to the peer. If timeout is provided and the operation does not complete in the specified duration, the returned Process fails with a java.nio.channels.InterruptedByTimeoutException.

    Completes when bytes are written to the socket.

  10. abstract def writes(timeout: Option[FiniteDuration] = None): Sink[F, Byte]

    Permalink

    Writes the supplied stream of bytes to this socket via write semantics.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to any2stringadd[Socket[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Socket[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to ArrowAssoc[Socket[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Socket[F]) ⇒ Boolean, msg: ⇒ Any): Socket[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Socket[F]) ⇒ Boolean): Socket[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Socket[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Socket[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to Ensuring[Socket[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to StringFormat[Socket[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (Socket[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Socket[F] to ArrowAssoc[Socket[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Socket[F] to any2stringadd[Socket[F]]

Inherited by implicit conversion StringFormat from Socket[F] to StringFormat[Socket[F]]

Inherited by implicit conversion Ensuring from Socket[F] to Ensuring[Socket[F]]

Inherited by implicit conversion ArrowAssoc from Socket[F] to ArrowAssoc[Socket[F]]

Ungrouped