Class

io.gearpump.streaming.task

TaskWrapper

Related Doc: package task

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    taskClass

    task class

    context

    context class

    userConf

    user config

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def actorOf(props: Props, name: String): ActorRef

    Permalink
    Definition Classes
    TaskWrapperTaskContext
  5. def actorOf(props: Props): ActorRef

    Permalink
    Definition Classes
    TaskWrapperTaskContext
  6. def appId: Int

    Permalink
    Definition Classes
    TaskWrapperTaskContext
  7. def appMaster: ActorRef

    Permalink

    The actorRef of AppMaster

    The actorRef of AppMaster

    returns

    application master's actor reference

    Definition Classes
    TaskWrapperTaskContext
  8. def appName: String

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

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def executorId: Int

    Permalink
    Definition Classes
    TaskWrapperTaskContext
  14. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    Any
  18. def logger: Logger

    Permalink

    logger is environment dependant, it should be provided by containing environment.

    logger is environment dependant, it should be provided by containing environment.

    Definition Classes
    TaskWrapperTaskContext
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

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

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

    Permalink

    Method called for each message received.

    Method called for each message received.

    msg

    message send by upstream tasks

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

    Permalink

    Method called with the task is initialized.

    Method called with the task is initialized.

    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
  24. def onStop(): Unit

    Permalink

    Method called when task is under clean up.

    Method called when task is under clean up. This can be used to cleanup resource when the application finished.

    Definition Classes
    TaskWrapperTaskInterface
  25. def output(index: Int, msg: Message): Unit

    Permalink

  26. def output(msg: Message): Unit

    Permalink

    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

    message to output

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

    Permalink

    Use with caution, output unmanaged message to target tasks

    Use with caution, output unmanaged message to target tasks

    msg

    message to output

    tasks

    the tasks to output to

  28. def parallelism: Int

    Permalink

    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

    the parallelism level

    Definition Classes
    TaskWrapperTaskContext
  29. def receiveUnManagedMessage: Receive

    Permalink

    handler for unmanaged message

    handler for unmanaged message

    returns

    the handler

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

    Permalink
    Definition Classes
    TaskWrapperTaskContext
  31. def scheduleOnce(initialDelay: FiniteDuration)(f: ⇒ Unit): Cancellable

    Permalink

    akka.actor.ActorRefProvider.scheduleOnce

    akka.actor.ActorRefProvider.scheduleOnce

    initialDelay

    the initial delay

    f

    the function to execute after initial delay

    returns

    the executable

    Definition Classes
    TaskWrapperTaskContext
  32. def self: ActorRef

    Permalink

    Please don't use this if possible.

    Please don't use this if possible.

    returns

    self actor ref

    Definition Classes
    TaskWrapperTaskContext
  33. def sender: ActorRef

    Permalink

    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

    sender

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

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

    Permalink
    Definition Classes
    AnyRef
  36. def system: ActorSystem

    Permalink

    Please don't use this if possible

    Please don't use this if possible

    returns

    the actor system

    Definition Classes
    TaskWrapperTaskContext
  37. val taskId: TaskId

    Permalink
    Definition Classes
    TaskWrapperTaskContext
  38. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  39. def upstreamMinClock: TimeStamp

    Permalink

    retrieve upstream min clock from TaskActor

    retrieve upstream min clock from TaskActor

    returns

    the min clock

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TaskInterface

Inherited from TaskContext

Inherited from AnyRef

Inherited from Any

Ungrouped