ReceiveMessageMaxBytes Property

General info

Label

Receive Message Max

Description

Maximum Kafka protocol response message size. This serves as a safety precaution to avoid memory exhaustion in case of protocol hickups.

Data type

Int32

Default value

100000000

Min value

1000

Max value

2147483647

Type

Regular

Code

6607

Symbolic name

MODEL_PROP_RECEIVEMESSAGEMAXBYTES

Lua access code

syslib.model.properties.ReceiveMessageMaxBytes

Available since

1.54

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.
PROP_HAS_DEFAULT The property has a default value as standard.
PROP_UNIT The property has an engineering unit.
PROP_HAS_LOLIMIT The property has a low limit.
PROP_HAS_HILIMIT The property has a high limit.

Examples

Read from or write to the ReceiveMessageMaxBytes property.

  • Lua

  • C#

-- Read from the ReceiveMessageMaxBytes
syslib.getvalue("<OBJECT FULL PATH>.KafkaProducerProperties.ReceiveMessageMaxBytes")

-- Write to the ReceiveMessageMaxBytes
syslib.setvalue("<OBJECT FULL PATH>.KafkaProducerProperties.ReceiveMessageMaxBytes", 100000000)
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the ReceiveMessageMaxBytes
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.KafkaProducerProperties.ReceiveMessageMaxBytes"));
// Write to the ReceiveMessageMaxBytes
Result result = sli.WriteValue(sc, new WriteItem(100000000, "<OBJECT FULL PATH>.KafkaProducerProperties.ReceiveMessageMaxBytes"));