Job engine on sillysky.net

CRecordAddJob

Tue, 09 Dec 2025 00:00:00 +0000

A new job is added to the Job Engine. The job must implement the interface IJob. The new job will wait in a queue to be used until a slot becomes available in a job thread of the same priority.

This message is sent internally to the Job Engine when the appendJob() method is called. However, it can also be sent to an engine by its owner.

{
  "id": "3a8ff4c4-dfc8-4bd8-b2b0-29d6b46a13e6",
  "name": "ADD_JOB",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Add a job.",
  "slots": [
    {
      "key": "1",
      "name": "JOB",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "OBJECT",
      "description": "The Job to add. Java type: IJob"
    }
  ]
}

CRecordAddJobEngineThread

Tue, 09 Dec 2025 00:00:00 +0000

This message is used to add a new thread to a job engine.

This message is sent internally to the Job Engine when the appendThread() method is called. However, it can also be sent to an engine by its owner.

The priority of the thread can be specified with a number between 1 (very low) and 10 (very high).

The maximum number of targets in a job engine thread is limited to 1-1000.

CRecordNoMoreJobs

Tue, 09 Dec 2025 00:00:00 +0000

This notification is sent by the job engine to the owner when there is no more job in progress.

{
  "id": "2d661800-888b-4b15-add0-0e120cf6da37",
  "name": "NO_MORE_JOBS",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Notification: No more jobs are running or pending.",
  "slots": [
  ]
}

CRecordNotifyJobFinished

Tue, 09 Dec 2025 00:00:00 +0000

This message is sent internally from a job thread to the job engine when a job has finished.
The job engine will then start another waiting job in this thread.

{
  "id": "cf854cf1-cdc6-457d-b3b5-0a9100aa4739",
  "name": "NOTIFY_JOB_FINISHED",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Notification: A job has been finished.",
  "slots": [
    {
      "key": "1",
      "name": "THREAD_QUEUE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The Job Queue ID."
    },
    {
      "key": "2",
      "name": "JOB_NAME",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The Job name."
    },
    {
      "key": "3",
      "name": "ELAPSED_TIME",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "LONG",
      "description": "The elapsed time in milliseconds."
    }
  ]
}

CRecordRemoveJob

Tue, 09 Dec 2025 00:00:00 +0000

Removes a job from the job engine. It does not matter whether the job is still waiting to be started or has already been started.

This message is sent internally to the Job Engine when the removeJob() method is called. However, it can also be sent to an engine by its owner.

{
  "id": "a92405b8-00a9-4ff8-9384-a1cae191a91b",
  "name": "REMOVE_JOB",
  "isNanoService": "false",
  "namespaces": "",
  "description": "Remove a job.",
  "slots": [
    {
      "key": "1",
      "name": "JOB_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "UUID",
      "description": "The Job ID."
    }
  ]
}