Properties of message

Refer to Messages chapter for detailed description.

Property Name

Allowed type / value

DSL Version

Required

Default Value

Description

name

name string

1

yes

Name of the message.

id

1

yes

Numeric ID of the message.

description

string

1

no

Human readable description of the message.

displayName

string

1

no

Name of the message to display. If empty, the code generator must use value of property name instead.

copyFieldsFrom

reference string

1

no

Message definition from which fields need to be copied.

order

1

no

0

Relative order of the messages with the same id.

sinceVersion

1

no

0

Version of the protocol in which message was introduced.

deprecated

1

no

max unsigned

Version of the protocol in which message was deprecated. Must be greater than value of sinceVersion.

removed

1

no

false

Indicates whether deprecated message has been removed from being supported.

sender

"both", "client", "server"

1

no

both

Endpoint that sends the message.

customizable

1

no

false

Mark the message to allow compile time customization regardless of code generator's level of customization.

copyFieldsAliases

3

no

true

Control copy of the defined aliases when copyFieldsFrom property is used to copy fields from the other <message>.

Extra child XML elements allowed:

XML Element

DSL Version

Description

<fields>

1

Wraps member fields.

<alias>

3

Alias names for other member fields. See Aliases for more info.

Last updated

Was this helpful?