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

CRecordTcpClient

This record is a data record, which means that it only contains data. It is used by the record CRecordTcpGetClientList. It contains the description of a single TCP client. 

{
  "id": "5113fced-053e-43b2-b1b8-f37aedb87222",
  "name": "TCP_CLIENT",
  "isNanoService": "false",
  "type": "DATA_RECORD",
  "hasOtherSlots": "false",
  "description": "A TCP client.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "type": "UUID",
      "description": "The ID."
    },
    {
      "key": "2",
      "name": "HOST",
      "type": "STRING",
      "description": "The remote host."
    },
    {
      "key": "3",
      "name": "PORT",
      "type": "INT",
      "description": "The remote port."
    },
    {
      "key": "4",
      "name": "TLS_ENABLED",
      "type": "BOOLEAN",
      "description": "True if this is a TLS socket."
    },
    {
      "key": "5",
      "name": "TLS_PROTOCOLS",
      "answer": false,
      "mandatory": false,
      "type": "STRING",
      "description": "The TLS protocol. Default: TLSv1.3"
    },
    {
      "key": "6",
      "name": "TLS_CIPHER_SUITES",
      "answer": false,
      "mandatory": false,
      "type": "STRING",
      "description": "The TLS cipher suite. Default: TLS_AES_128_GCM_SHA256"
    },
    {
      "key": "7",
      "name": "INPUT_BUFFER_SIZE",
      "type": "INT",
      "description": "The input buffer size."
    },
    {
      "key": "8",
      "name": "RETRY_TIMEOUT",
      "type": "LONG",
      "description": "The retry timeout in ms."
    },
    {
      "key": "9",
      "name": "IS_CONNECTED",
      "type": "BOOLEAN",
      "description": "True if the client is connected."
    },
    {
      "key": "10",
      "name": "LOCAL_PORT",
      "type": "INT",
      "description": "The local port."
    }
  ]
}

Slot Description

Key Name Type Description
1 ID UUID The ID of the client.
2 HOST STRING The remote host.
3 PORT INT The remote port.
4 TLS_ENABLED BOOLEAN True if this is a TLS socket.
5 TLS_PROTOCOLS STRING The TLS protocol. Default: TLSv1.3.
6 TLS_CIPHER_SUITES STRING The TLS cipher suite. Default: TLS_AES_128_GCM_SHA256.
7 INPUT_BUFFER_SIZE INT The input buffer size.
8 RETRY_TIMEOUT LONG The retry timeout in ms.
9 IS_CONNECTED BOOLEAN True if the client is connected.
10 LOCAL_PORT INT The local port.

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