Cookies improve the way our website works, by using this website you are agreeing to our use of cookies. For more information see our privacy policy. OK

CRecordTcpGetClientList

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

The list of clients come back as an array of records. The type of each record is CRecordTcpClient. 

{
    "id": "b6490ad1-e317-4001-950c-68d3c7f62850",
    "name": "TCP_GET_CLIENT_LIST",
    "isNanoService": "true",
    "type": "REQUEST",
    "hasOtherSlots": "false",
    "description": "Get a list of TCP clients.",
    "namespaces": "SYSTEM",
    "slots": [
        {
            "key": "1",
            "name": "CLIENTS",
            "direction": "RESPONSE",
            "presenceConstraint": "MANDATORY",
            "type": "RECORD_ARRAY",
            "description": "The list of clients. TYPE of record: TCP_CLIENT"
        }
    ]
}

Slot Description

Key Name Direction Presence Constraint Type Description
1 CLIENTS RESPONSE MANDATORY RECORD_ARRAY The list of clients. TYPE of record: CRecordTcpClient

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