Packages

trait Socket[F[_]] extends AnyRef

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

Source
Socket.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
TLSSocket
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Socket
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def endOfInput: F[Unit]

    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. This is a no-op on Node.js.

  2. abstract def endOfOutput: F[Unit]

    Indicates to peer, we are done writing.

    Indicates to peer, we are done writing. *

  3. abstract def isOpen: F[Boolean]
  4. abstract def localAddress: F[SocketAddress[IpAddress]]

    Asks for the local address of the socket.

  5. abstract def read(maxBytes: Int): F[Option[Chunk[Byte]]]

    Reads up to maxBytes from the peer.

    Reads up to maxBytes from the peer.

    Returns None if the "end of stream" is reached, indicating there will be no more bytes sent.

  6. abstract def readN(numBytes: Int): F[Chunk[Byte]]

    Reads exactly numBytes from the peer in a single chunk.

    Reads exactly numBytes from the peer in a single chunk.

    Returns a chunk with size < numBytes upon reaching the end of the stream.

  7. abstract def reads: Stream[F, Byte]

    Reads bytes from the socket as a stream.

  8. abstract def remoteAddress: F[SocketAddress[IpAddress]]

    Asks for the remote address of the peer.

  9. abstract def write(bytes: Chunk[Byte]): F[Unit]

    Writes bytes to the peer.

    Writes bytes to the peer.

    Completes when the bytes are written to the socket.

  10. abstract def writes: Pipe[F, Byte, Nothing]

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped