Class/Object

scales.utils.io

ReadableByteChannelWrapper

Related Docs: object ReadableByteChannelWrapper | package io

Permalink

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.

Linear Supertypes
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
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])

    Permalink

    directBufferArrayPool

    is used when there is a direct ByteBuffer only.

Value Members

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

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

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

    Permalink
    Definition Classes
    CloseOnNeed
  4. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  6. val backingArray: Array[Byte]

    Permalink
    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperReadableByteChannelWrapperBase
  7. val buffer: ByteBuffer

    Permalink
    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperReadableByteChannelWrapperBase
  8. val channel: ReadableByteChannel

    Permalink
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val closeChannel: Boolean

    Permalink
  11. def closeResource: Unit

    Permalink

    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

    Permalink

    Called when processing via Direct Buffers

    Called when processing via Direct Buffers

    Attributes
    protected
    Definition Classes
    ReadableByteChannelWrapperBase
  13. def doClose: Unit

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. implicit val ev: DataChunkEvidence[T]

    Permalink
  17. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def isClosed: Boolean

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

    Permalink
    Definition Classes
    Any
  22. def jbytes(): DataChunk

    Permalink

    Called when processing array backed buffers

    Called when processing array backed buffers

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

    Permalink
    Definition Classes
    AnyRef
  24. final def nextChunk: DataChunk

    Permalink

    Receives the next chunk from the underlying

    Receives the next chunk from the underlying

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  29. def underlyingClosed: Boolean

    Permalink

    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
  30. final def wait(): Unit

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

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

    Permalink
    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