PDComm.GemFormattedProgramOptions

Class

Limits for S7F27/S7F28 process program verification sends.

public sealed record GemFormattedProgramOptions

Pass the options to GemFormattedPrograms.ConfigureVerificationReports, or set GemFormattedProgramConfiguration.VerificationReports, once while the endpoint is stopped; a second configuration fails with PdcommStatus.InvalidState. A limit marked as nonzero fails configuration with PdcommStatus.InvalidArgument when it is zero. The other limits are not checked for zero; a zero limit admits only content that needs none of that resource. Values are application policy, not standard defaults. The equipment sends an S7F27 report with GemFormattedPrograms.SubmitVerificationReport; the host receives it and answers with S7F28.

Parameters

Name	Description
MaxIssues	The largest number of issues in one S7F27 report, sent or received.
MaxIssueTextBytes	The longest issue text (ERRW7), in bytes.
MaxTotalIssueTextBytes	The largest total length, in bytes, of all issue texts of one report.
MaxPending	The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
MaxReceived	The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
MaxResults	The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
MaxHistory	The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.

Members

GemFormattedProgramOptions

Constructor

Limits for S7F27/S7F28 process program verification sends.

public GemFormattedProgramOptions(nuint MaxIssues, nuint MaxIssueTextBytes, nuint MaxTotalIssueTextBytes, nuint MaxPending, nuint MaxReceived, nuint MaxResults, nuint MaxHistory)

Pass the options to GemFormattedPrograms.ConfigureVerificationReports, or set GemFormattedProgramConfiguration.VerificationReports, once while the endpoint is stopped; a second configuration fails with PdcommStatus.InvalidState. A limit marked as nonzero fails configuration with PdcommStatus.InvalidArgument when it is zero. The other limits are not checked for zero; a zero limit admits only content that needs none of that resource. Values are application policy, not standard defaults. The equipment sends an S7F27 report with GemFormattedPrograms.SubmitVerificationReport; the host receives it and answers with S7F28.

Parameters

Name	Description
MaxIssues	The largest number of issues in one S7F27 report, sent or received.
MaxIssueTextBytes	The longest issue text (ERRW7), in bytes.
MaxTotalIssueTextBytes	The largest total length, in bytes, of all issue texts of one report.
MaxPending	The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
MaxReceived	The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
MaxResults	The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
MaxHistory	The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.

MaxHistory

Property

The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.

public nuint MaxHistory { get; init; }

MaxIssueTextBytes

Property

The longest issue text (ERRW7), in bytes.

public nuint MaxIssueTextBytes { get; init; }

MaxIssues

Property

The largest number of issues in one S7F27 report, sent or received.

public nuint MaxIssues { get; init; }

MaxPending

Property

The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.

public nuint MaxPending { get; init; }

MaxReceived

Property

The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.

public nuint MaxReceived { get; init; }

MaxResults

Property

The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.

public nuint MaxResults { get; init; }

MaxTotalIssueTextBytes

Property

The largest total length, in bytes, of all issue texts of one report.

public nuint MaxTotalIssueTextBytes { get; init; }