SessionSubmit

SessionSubmit[expr]

submits an asynchronous task to evaluate expr in the current session.

SessionSubmit[ScheduledTask[expr,spec]]

submits a task to evaluate expr in the current session on the schedule defined by spec.

Details and Options

  • SessionSubmit[] returns TaskObject[] to represent the task it creates.
  • The following options can be given:
  • HandlerFunctions<||>how to handle generated events
    HandlerFunctionsKeysAutomaticparameters to supply to handler functions
    MethodAutomatichow to determine when to allow the task to run
  • Possible settings for the Method option include:
  • "Idle"run only when the session is waiting for user input
    Automaticrun at any time, including during computations
  • During the execution of the task, the following events can be generated:
  • "TaskStarted"task is started
    "ScheduleTriggered"scheduled task evaluation is beginning
    "MessageGenerated"evaluation generated a message
    "PrintOutputGenerated"evaluation generated print output
    "ResultReceived"evaluation generated a result
    "ScheduleExecuted"scheduled task evaluation is executed
    "TaskStatusChanged"task status changed
    "TaskFinished"task is completely finished
    "TaskRemoved"task is being removed
  • With the specification HandlerFunctions-><|,"eventi"->fi,|>, fi[assoc] is evaluated whenever eventi is generated. The elements of assoc have keys specified by the setting for HandlerFunctionsKeys.
  • Possible keys specified by HandlerFunctionsKeys include:
  • "EvaluationExpression"expression being evaluated
    "EvaluationResult"result of the evaluation
    "MessageOutput"content of message generated
    "PrintOutput"content of print output generated
    "Task"the object representing the task
    "TaskStatus"the status of the task
    "TaskType"type of the task
    "TaskUUID"unique task identifier
    "EventName"the name of the event being handled
  • The expression to evaluate is returned wrapped in Hold.
  • For scheduled tasks, the following additional keys can be specified:
  • "Schedule"task schedule specification
    "RunInterval"interval between task runs
    "PreviousRunCount"number of times the task has already run
    "RemainingRunCount"number of times the task still has to run
    "TotalRunCount"total number of times the task is scheduled to run
  • The task submitted by SessionSubmit is run in the current Wolfram Language session and has access to all variables and other states of that session.
  • The task is run preemptively, both when the system is waiting for input and during other evaluations.

Examples

Basic Examples  (10)

Create a task to show a message dialog:

In[1]:=
Click for copyable input
Out[1]=

The task runs in the current session:

In[1]:=
Click for copyable input
Out[1]=
Out[1]=
In[2]:=
Click for copyable input
Out[2]=

Create a task to show a message dialog after 2 seconds:

In[1]:=
Click for copyable input
Out[1]=

Use a Quantity object to specify time:

In[1]:=
Click for copyable input
Out[1]=

Display the result of evaluation after the task is finished:

In[1]:=
Click for copyable input
Out[1]=

Capture messages generated during the evaluation:

In[1]:=
Click for copyable input
Out[1]=

Format message output as a regular message:

In[2]:=
Click for copyable input
Out[2]=

Capture Print output from the evaluation:

In[1]:=
Click for copyable input
Out[1]=

Information about the task is available to the expression being evaluated:

In[1]:=
Click for copyable input
Out[1]=

Information about the task is available to event handlers:

In[1]:=
Click for copyable input
Out[1]=

Get notified when the task status changes:

In[1]:=
Click for copyable input
Out[1]=

See Also

LocalSubmit  CloudSubmit  URLSubmit  TaskObject  TaskSuspend  TaskRemove  Dynamic

Introduced in 2017
(11.2)