scales.utils.io

ReadableByteChannelWrapper

class ReadableByteChannelWrapper[T] extends ReadableByteChannelWrapperBase[T]

Wraps a ReadableByteChannel to provide DataChunks, optionally closes the channel (defaults to closing).

Can work with either direct or heap based buffers and uses pools to re-use the allocated buffers.

Source
ReadableByteChannelWrapper.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReadableByteChannelWrapper
  2. ReadableByteChannelWrapperBase
  3. DataChunker
  4. CloseOnNeed
  5. IsClosed
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReadableByteChannelWrapper(channel: ReadableByteChannel, closeChannel: Boolean = true, bytePool: Pool[ByteBuffer] = DefaultBufferPool, directBufferArrayPool: Pool[Array[Byte]] = DefaultByteArrayPool)(implicit ev: DataChunkEvidence[T])

    directBufferArrayPool

    is used when there is a direct ByteBuffer only.

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def ++(close2: CloseOnNeed): CloseOnNeed

    Definition Classes
    CloseOnNeed
  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. val backingArray: Array[Byte]

    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperReadableByteChannelWrapperBase
  9. val buffer: ByteBuffer

    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperReadableByteChannelWrapperBase
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def closeResource: Unit

    Close the underlying something, but only do it once.

    Close the underlying something, but only do it once.

    This allows closing of an xml input stream directly after the end doc, but without disturbing the normal model.

    Definition Classes
    CloseOnNeed
  12. def direct(): DataChunk

    Called when processing via Direct Buffers

    Called when processing via Direct Buffers

    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperBase
  13. def doClose: Unit

    Closes the channel when closeChannel is true - ensure to call from derived classes

    Closes the channel when closeChannel is true - ensure to call from derived classes

    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperReadableByteChannelWrapperBaseCloseOnNeed
  14. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  19. def isClosed: Boolean

    Definition Classes
    CloseOnNeedIsClosed
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def jbytes(): DataChunk

    Called when processing array backed buffers

    Called when processing array backed buffers

    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperBase
  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def nextChunk: DataChunk

    Receives the next chunk from the underlying

    Receives the next chunk from the underlying

    Definition Classes
    ReadableByteChannelWrapperBaseDataChunker
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    AnyRef → Any
  28. def underlyingClosed: Boolean

    Is the underlying resource closed - if true the dataChunkEnumerator will return the Iteratee passed to it, stopping evaluation

    Is the underlying resource closed - if true the dataChunkEnumerator will return the Iteratee passed to it, stopping evaluation

    Definition Classes
    ReadableByteChannelWrapperBaseDataChunker
  29. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ReadableByteChannelWrapperBase[T]

Inherited from DataChunker[T]

Inherited from CloseOnNeed

Inherited from IsClosed

Inherited from AnyRef

Inherited from Any

Ungrouped