CRecordTcpGetServerList

A message with this record requests a list of existing TCP servers inside the own node. This is a nano service in the SYSTEM namespace.

The response consists of a list of servers consisting of records of type CRecordTcpServer.

{
    "id": "385baa58-29b3-471e-80ca-f2d7967bbc3d",
    "name": "TCP_GET_SERVER_LIST",
    "isNanoService": "true",
    "type": "REQUEST",
    "hasOtherSlots": "false",
    "description": "Get a list of TCP servers.",
    "namespaces": "SYSTEM",
    "slots": [
        {
            "key": "1",
            "name": "SERVERS",
            "direction": "RESPONSE",
            "presenceConstraint": "MANDATORY",
            "type": "RECORD_ARRAY",
            "description": "The list of servers. Record type: CRecordTcpServer"
        }
    ]
}

Slot Description

Key Name Direction Presence Constraint Type Description
1 SERVERS RESPONSE MANDATORY RECORD_ARRAY The list of servers. Record type: CRecordTcpServer

Record Usage

In nyssr.net, we typically don't exchange interfaces between projects. Instead, we use platform-independent Records to describe message formats.

One or more descriptions of these Records are stored in the JSON or XML format as record.json or record.xml within a directory. The Record Generator, an included Swing tool, generates helper classes from these files. These classes can then be used to type-safely write or read messages.

See also