Console Records on sillysky.net

CRecordCliAddHandler

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

The message adds a handler for one or more console commands. When the user enters these commands, a message containing the input is sent to the registered handler. In response, the handler sends back a text that is displayed on the console.

This message is part of the console API. It is a nanoservice in the SYSTEM namespace.

{
  "id": "3eaa3a56-5a84-4f11-b2fc-62da19141013",
  "name": "CLI_ADD_HANDLER",
  "isNanoService": "true",
  "namespaces": "SYSTEM",
  "description": "Add a Command Handler.",
  "slots": [
    {
      "key": "1",
      "name": "COMMAND",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The commands."
    },
    {
      "key": "2",
      "name": "HELP",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The help texts."
    }
  ]
}

Arguments

COMMAND is the command for which a handler should be registered. Multiple commands can be registered simultaneously; therefore, the argument is a string array.
HELP is a help text that is displayed for the command when "?" or "help" is entered on the command line. Multiple commands can be registered simultaneously; therefore, the argument is a string array.

The handler itself is identified by the sender address of the message.

CRecordCliGetHelp

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

This message is sent from the console display target to the console service to obtain help output for the registered commands.

The message is part of the console API. It is a nanoservice in the SYSTEM namespace.

{
  "id": "a53b0278-48e1-48b1-9220-8cc1a4d73197",
  "name": "CLI_GET_HELP",
  "description": "Get the local help output.",
  "slots": [
    {
      "key": "1",
      "name": "HELP",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "The help for the local command line."
    }
  ]
}

Arguments

HELP is the response from the console service. It is a help text for each registered command.

Usage

Sending a request when you already have the address of the desired command service:

CRecordCliHandle

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

This message is sent to registered console handlers when the user enters a registered command in the console. The message includes the command and any parameters entered. The response to this message should contain the text to be displayed on the console.

The message is part of the console API.

{
  "id": "d9c9e057-b172-40a5-8ae0-23d51e226321",
  "name": "CLI_HANDLE",
  "description": "Forward the command line to the command line manager.",
  "slots": [
    {
      "key": "1",
      "name": "COMMAND_LINE",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The command line."
    },
    {
      "key": "2",
      "name": "DISPLAY",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "The target address of the display."
    },
    {
      "key": "3",
      "name": "COMMAND",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The command."
    },
    {
      "key": "4",
      "name": "ARGUMENTS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING_ARRAY",
      "description": "The arguments."
    },
    {
      "key": "10",
      "name": "IS_VALID_COMMAND",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "BOOLEAN",
      "description": "True if the command line is a valid command. The command will be added to the history buffer."
    },
    {
      "key": "11",
      "name": "OUTPUT",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "STRING",
      "description": "The output caused by the command."
    }
  ]
}

Arguments

COMMAND_LINE contains the user's input.
DISPLAY indicates the address of the display where the user made the input.
COMMAND is the instruction recognized by the interpreter.
ARGUMENTS are the tokens that were appended to the command.
IS_VALID_COMMAND is true if the input is recognized as a valid command.
OUTPUT indicates the text that should be displayed on the console as a response to the command.

Usage

Registration of the message handler for CRecordCliHandle:

CRecordCliRemoveHandler

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

The message removes a registered handler for a console command.

This message is part of the console API. It is a nanoservice in the SYSTEM namespace.

{
  "id": "aaee82f5-17a1-4925-a0a5-02c1260cb25b",
  "name": "CLI_REMOVE_HANDLER",
  "isNanoService": "true",
  "namespaces": "SYSTEM",
  "description": "Remove a Command Handler.",
  "slots": [
    {
      "key": "1",
      "name": "COMMAND",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The command."
    }
  ]
}

Arguments

COMMAND is the registered command for which the handler should be removed. The handler itself is identified by the sender address of the message. The argument is optional: If it is missing, all registered commands of the handler will be removed.

Usage

private void removeCommandLineHandler() throws CException
{
    final CEnvelope env = CEnvelope.forLocalNanoService(CWellKnownNID.SYSTEM);
    final CRecord record = CRecordCliRemoveHandler.create();
    CRecordCliRemoveHandler.setCommand(record,
                                       "quit");
    sendNotification(env,
                     record);
}

CRecordCliAttachDisplay

Thu, 23 Oct 2025 00:00:00 +0000

This message is sent from the console display to the console service to redirect the console service's output to the display.

The message is part of the console API.

{
  "id": "69bb3e3a-dbf6-40ca-a2a0-2b3b67a93232",
  "name": "CLI_ATTACH_DISPLAY",
  "description": "Attach a display to the command line service.",
  "slots": [
  ]
}

Arguments

The service uses the sender address of the message as the address of the display.

Usage

The display target sends this message to the command line service that each node possesses. The command line service has a nanoservice API, so this message is sent to the nanoservice.