io.gearpump.streaming.task

TaskWrapper

Related Doc: package task

class TaskWrapper extends TaskContext with TaskInterface

This provides TaskContext for user defined tasks

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TaskWrapper
  2. TaskInterface
  3. TaskContext
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TaskWrapper(taskId: TaskId, taskClass: Class[_ <: Task], context: TaskContextData, userConf: UserConfig)

    taskClass

    task class

    context

    context class

    userConf

    user config

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. def actorOf(props: Props, name: String): ActorRef

    Definition Classes
    TaskWrapperTaskContext
    See also

    ActorRefProvider.actorOf

  5. def actorOf(props: Props): ActorRef

    Definition Classes
    TaskWrapperTaskContext
    See also

    ActorRefProvider.actorOf

  6. def appId: Int

    Definition Classes
    TaskWrapperTaskContext
  7. def appMaster: ActorRef

    The actorRef of AppMaster

    The actorRef of AppMaster

    returns

    Definition Classes
    TaskWrapperTaskContext
  8. def appName: String

    Definition Classes
    TaskWrapperTaskContext
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  13. def executorId: Int

    Definition Classes
    TaskWrapperTaskContext
  14. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. final def notify(): Unit

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

    Definition Classes
    AnyRef
  21. def onNext(msg: Message): Unit

    msg

    message send by upstream tasks

    Definition Classes
    TaskWrapperTaskInterface
  22. def onStart(startTime: StartTime): Unit

    startTime

    startTime that can be used to decide from when a source producer task should replay the data source, or from when a processor task should recover its checkpoint data in to in-memory state.

    Definition Classes
    TaskWrapperTaskInterface
  23. def onStop(): Unit

    This can be used to cleanup resource when the application finished.

    This can be used to cleanup resource when the application finished.

    Definition Classes
    TaskWrapperTaskInterface
  24. def output(msg: Message): Unit

    This can be used to output messages to downstream tasks.

    This can be used to output messages to downstream tasks.

    The data shuffling rule can be decided by Partitioner.

    msg

    Definition Classes
    TaskWrapperTaskContext
  25. def outputUnManaged(msg: AnyRef, tasks: TaskId*): Unit

    Use with caution, output unmanaged message to target tasks

    Use with caution, output unmanaged message to target tasks

    msg
    tasks

  26. def parallelism: Int

    The task parallelism

    The task parallelism

    For example, we can create 3 source tasks, and 3 sink tasks, the task parallelism is 3 for each.

    This can be useful when reading from partitioned data source. For example, for kafka, there may be 10 partitions, if we have parallelism of 2 for this task, then each task will be responsible to read data from 5 partitions.

    returns

    Definition Classes
    TaskWrapperTaskContext
  27. def receiveUnManagedMessage: Receive

    handler for unmanaged message

    handler for unmanaged message

    returns

    Definition Classes
    TaskWrapperTaskInterface
  28. def schedule(initialDelay: FiniteDuration, interval: FiniteDuration)(f: ⇒ Unit): Cancellable

    Definition Classes
    TaskWrapperTaskContext
    See also

    ActorRefProducer.schedule

  29. def scheduleOnce(initialDelay: FiniteDuration)(f: ⇒ Unit): Cancellable

    ActorRefProvider.scheduleOnce

    ActorRefProvider.scheduleOnce

    initialDelay
    f
    returns

    Definition Classes
    TaskWrapperTaskContext
  30. def self: ActorRef

    Please don't use this if possible.

    Please don't use this if possible.

    returns

    Definition Classes
    TaskWrapperTaskContext
  31. def sender: ActorRef

    For managed message(type of Message), the sender only serve as a unique Id, It's address is not something meaningful, you should not use this directly

    For managed message(type of Message), the sender only serve as a unique Id, It's address is not something meaningful, you should not use this directly

    For unmanaged message, the sender represent the sender ActorRef

    returns

    Definition Classes
    TaskWrapperTaskContext
  32. def setTaskActor(actor: TaskActor): Unit

  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  34. def system: ActorSystem

    Please don't use this if possible

    Please don't use this if possible

    returns

    Definition Classes
    TaskWrapperTaskContext
  35. val taskId: TaskId

    Definition Classes
    TaskWrapperTaskContext
  36. def toString(): String

    Definition Classes
    AnyRef → Any
  37. def upstreamMinClock: TimeStamp

    retrieve upstream min clock from TaskActor

    retrieve upstream min clock from TaskActor

    returns

    Definition Classes
    TaskWrapperTaskContext
  38. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TaskInterface

Inherited from TaskContext

Inherited from AnyRef

Inherited from Any

Ungrouped