Engine::SessionExtraParameters::ValidationParameters Struct Reference

Validation parameters. More...

#include <B2BITS_SessionParameters.h>

Collaboration diagram for Engine::SessionExtraParameters::ValidationParameters:

Public Attributes
TriBool	allowZeroNumInGroup_
	When true, raw message may contains leading group tag with 0 value - it will be ignored.
TriBool	checkRequiredGroupFields_
	This parameter controls the validation of required fields in repeating group.
TriBool	ignoreUnknownFields_
	Ignore undefined fields during message parsing.
TriBool	isEnabled_
	Option to enable message validation.
TriBool	prohibitDuplicatedTags_
	When false, raw message may contains duplicated field definitions.
TriBool	prohibitTagsWithoutValue_
	When false, raw message may contains tags without values - they will be ignored.
TriBool	prohibitUnknownTags_
	This parameter controls unknown tag handling.
TriBool	verifyRepeatingGroupBounds_
	This parameter controls repeating group size checking.
TriBool	verifyRepeatingGroupTagsOrder_
	When true, checks order of tags inside repeating group.
TriBool	verifyTagsValues_
	This parameter controls tag values validation.

Detailed Description

Validation parameters.

Member Data Documentation

allowZeroNumInGroup_

TriBool Engine::SessionExtraParameters::ValidationParameters::allowZeroNumInGroup_

When true, raw message may contains leading group tag with 0 value - it will be ignored.

Otherwise reject will be fired.

checkRequiredGroupFields_

TriBool Engine::SessionExtraParameters::ValidationParameters::checkRequiredGroupFields_

This parameter controls the validation of required fields in repeating group.

The possible values are "true" and "false". If set to "true" then repeating groups will be checked for presence of required fields. If set to "false" then the responsibility for repeating group validity rests with the counterparty. The recommended setting is "true". This parameter is optional. The default value is "true".

ignoreUnknownFields_

TriBool Engine::SessionExtraParameters::ValidationParameters::ignoreUnknownFields_

Ignore undefined fields during message parsing.

isEnabled_

TriBool Engine::SessionExtraParameters::ValidationParameters::isEnabled_

Option to enable message validation.

Pass true to enable; false to disable.

prohibitDuplicatedTags_

TriBool Engine::SessionExtraParameters::ValidationParameters::prohibitDuplicatedTags_

When false, raw message may contains duplicated field definitions.

Otherwise reject will be fired.

prohibitTagsWithoutValue_

TriBool Engine::SessionExtraParameters::ValidationParameters::prohibitTagsWithoutValue_

When false, raw message may contains tags without values - they will be ignored.

Otherwise std::exception was fired.

prohibitUnknownTags_

TriBool Engine::SessionExtraParameters::ValidationParameters::prohibitUnknownTags_

This parameter controls unknown tag handling.

The possible values are "true" and "false". If set to "true" then all unknown fields will be stored to the message. If set to "false", engine will reject messages with unknown fields. Default: false

verifyRepeatingGroupBounds_

TriBool Engine::SessionExtraParameters::ValidationParameters::verifyRepeatingGroupBounds_

This parameter controls repeating group size checking.

If true, engine will reject messages with incorrect repeating group size. Otherwise message will be passed to the application layer. In this case the responsibility for message validity rests with the counterparty. Default: false

verifyRepeatingGroupTagsOrder_

TriBool Engine::SessionExtraParameters::ValidationParameters::verifyRepeatingGroupTagsOrder_

When true, checks order of tags inside repeating group.

verifyTagsValues_

TriBool Engine::SessionExtraParameters::ValidationParameters::verifyTagsValues_

This parameter controls tag values validation.

The possible values are "true" and "false". If set to "true" then all messages will be validated. If set to "false" then the responsibility for message validity rests with the counterparty. Default: false