c

com.nvidia.spark.rapids.shuffle

BufferReceiveState

class BufferReceiveState extends AutoCloseable with Logging

A helper case class to maintain the state associated with a transfer request to a peer.

On getBufferWhenReady(finalizeCb, size), a bounce buffer is either made immediately available to finalizeCb or it will be made available later, via toFinalize.

By convention, the id is used as the header for receives for this BufferReceiveState

consumeWindow is called when data has arrived at the bounce buffer, copying onto the ranges the bytes received.

It also is AutoCloseable. close() should be called to free bounce buffers.

Linear Supertypes
Logging, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BufferReceiveState
  2. Logging
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BufferReceiveState(id: Long, bounceBuffer: BounceBuffer, requests: Seq[PendingTransferRequest], transportOnClose: () ⇒ Unit, stream: Stream = Cuda.DEFAULT_STREAM)

    id

    - a numeric id that is used in all headers for this BufferReceiveState

    bounceBuffer

    - bounce buffer to use (device memory strictly)

    requests

    - collection of PendingTransferRequest as issued by iterators currently requesting

    transportOnClose

    - a callback invoked when the BufferReceiveState closes

    stream

    - CUDA stream to use for allocations and copies

Type Members

  1. class ReceiveBlock extends BlockWithSize

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( ... ) @native()
  6. def close(): Unit
    Definition Classes
    BufferReceiveState → AutoCloseable
  7. def consumeWindow(): Seq[ConsumedBatchFromBounceBuffer]

    When a receive is complete, the client calls consumeWindow to copy out of the bounce buffer in this BufferReceiveState any complete batches, or to buffer up a remaining batch in workingOn

    When a receive is complete, the client calls consumeWindow to copy out of the bounce buffer in this BufferReceiveState any complete batches, or to buffer up a remaining batch in workingOn

    returns

    - a sequence of batches that were successfully consumed, or an empty sequence if still working on a batch.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def errorOccurred(errMsg: String, throwable: Throwable = null): Unit

    Calls transferError on each RapidsShuffleFetchHandler

    Calls transferError on each RapidsShuffleFetchHandler

    errMsg

    - the message to pass onto the handlers

  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def getBufferWhenReady(finalizeCb: (TransportBuffer) ⇒ Unit, size: Long): Unit
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getRequests: Seq[PendingTransferRequest]
  15. def hasMoreBlocks: Boolean
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. val id: Long
  18. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  19. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  22. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  23. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  30. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. var toConsume: Int
  39. var toFinalize: ArrayDeque[(TransportBuffer) ⇒ Unit]
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. val transportBuffer: CudfTransportBuffer
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Logging

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped