c

com.nvidia.spark.rapids.shuffle

RapidsShuffleClient

class RapidsShuffleClient extends Logging with AutoCloseable

The client makes requests via a ClientConnection obtained from the RapidsShuffleTransport.

This class handles fetch requests from RapidsShuffleIterator, turning them into ShuffleMetadata messages, and shuffle TransferRequests.

Its counterpart is the RapidsShuffleServer on a specific peer executor, specified by connection.

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

Instance Constructors

  1. new RapidsShuffleClient(connection: ClientConnection, transport: RapidsShuffleTransport, exec: Executor, clientCopyExecutor: Executor, catalog: ShuffleReceivedBufferCatalog = GpuShuffleEnv.getReceivedCatalog)

    connection

    a connection object against a remote executor

    transport

    used to get metadata buffers and to work with the throttle mechanism

    exec

    Executor used to handle tasks that take time, and should not be in the transport's thread

    clientCopyExecutor

    Executors used to handle synchronous mem copies

    catalog

    catalog to use to track received shuffle blocks

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 cancelPending(handler: RapidsShuffleFetchHandler): Unit

    Cancel pending requests for handler handler to the peer represented by this client.

    Cancel pending requests for handler handler to the peer represented by this client.

    handler

    instance to use to find requests to cancel

    Note

    this currently only cancels pending requests that are queued in the transport, and not in flight.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def close(): Unit
    Definition Classes
    RapidsShuffleClient → AutoCloseable
  8. val connection: ClientConnection
  9. def doFetch(shuffleRequests: Seq[ShuffleBlockBatchId], handler: RapidsShuffleFetchHandler): Unit

    Starts a fetch request for all the shuffleRequests, using handler to communicate events back to the iterator.

    Starts a fetch request for all the shuffleRequests, using handler to communicate events back to the iterator.

    shuffleRequests

    blocks to fetch

    handler

    iterator to callback to

  10. def doHandleBounceBufferReceive(tx: Transaction, bufferReceiveState: BufferReceiveState): Unit

    This function handles data received in bounceBuffers.

    This function handles data received in bounceBuffers. The data should be copied out of the buffers, and the function should call into bufferReceiveState to advance its state (consumeBuffers)

    tx

    live transaction for these bounce buffers, it should be closed in this function

    bufferReceiveState

    state management objects for live transfer requests

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def handleBufferReceive(tx: Transaction, bufferReceiveState: BufferReceiveState): Unit
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  18. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  21. def issueBufferReceives(bufferReceiveState: BufferReceiveState): Unit

    Used by the transport, to schedule receives.

    Used by the transport, to schedule receives. The requests are sent to the executor for this client.

    bufferReceiveState

    object tracking the state of pending TransferRequests

  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. def registerPeerErrorListener(handler: RapidsShuffleFetchHandler): Unit
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. def unregisterPeerErrorListener(handler: RapidsShuffleFetchHandler): Unit
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  44. object ShuffleClientOps

Inherited from AutoCloseable

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped