Listener - task : Listener

Represents a ballerina task listener, which can be used to schedule and execute tasks periodically.

Methods

__detach

(service s)

returns error?

Parameters

  • s service
  • Return Type

    (error?)

__gracefulStop

()

returns error?

  • Return Type

    (error?)

__immediateStop

()

returns error?

  • Return Type

    (error?)

pause

()

returns ListenerError?

Pauses the task listener.

  • Return Type

    (ListenerError?)
  • Returns task:ListenerError if an error is occurred while resuming, nil Otherwise.

resume

()

returns ListenerError?

Resumes a paused task listener.

  • Return Type

    (ListenerError?)
  • Returns task:ListenerError when an error occurred while pausing, nil Otherwise.

LifeCycle Methods

__attach

(service s, string? name)

returns error?

Parameters

  • s service
  • name string? (default ())
  • Return Type

    (error?)

__start

()

returns error?

  • Return Type

    (error?)