Trait/Object

spinoco.fs2.interop.ssl

SSLEngine

Related Docs: object SSLEngine | package ssl

Permalink

trait SSLEngine[F[_]] extends AnyRef

Helper to establish asynchronous interface around jns.SSLEngine

Please note that all operations here are not safe to be invoked concurrently. User of this interface must assure that any wrapXXX or unwrapXX are not called concurrently.

Source
SSLEngine.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SSLEngine
  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 closeInbound: F[Unit]

    Permalink

    Inbound stream (from remote party) is done, ndo no more data will be received *

  2. abstract def closeOutbound: F[Unit]

    Permalink

    Outbound stream (to remote party) is done, and no more data will be sent *

  3. abstract def startHandshake: F[Unit]

    Permalink

    Starts the SSL Handshake.

  4. abstract def unwrap(bytes: Chunk[Byte]): F[Result]

    Permalink

    Unwraps the data received from the network to data expected from application

    Unwraps the data received from the network to data expected from application

    If the engine needs to perform any asynchronous operations, these are performed before resulting task finishes.

    User of this API shall assure that no concurrent unwrap operations are executed

    bytes

    Secure data received over the wire

  5. abstract def unwrapAvailable: F[Int]

    Permalink

    available space in unwrap buffer *

  6. abstract def wrap(bytes: Chunk[Byte]): F[Result]

    Permalink

    Wraps presented source buffer to network Buffer.

    Wraps presented source buffer to network Buffer.

    If the engine needs to perform any asynchronous operations, these are performed before resulting task finishes.

    User of this API shall assure that no concurrent wrap operations are executed

    bytes

    Unsecured application data

  7. abstract def wrapAvailable: F[Int]

    Permalink

    available space in wrap buffer *

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 SSLEngine[F] to any2stringadd[SSLEngine[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SSLEngine[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SSLEngine[F] to ArrowAssoc[SSLEngine[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: (SSLEngine[F]) ⇒ Boolean, msg: ⇒ Any): SSLEngine[F]

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from SSLEngine[F] to Ensuring[SSLEngine[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 SSLEngine[F] to StringFormat[SSLEngine[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): (SSLEngine[F], B)

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped