PDComm.GemFormattedProgramTransferOptions

Class

Limits for S7F23/S7F24 formatted process program sends.

public sealed record GemFormattedProgramTransferOptions

Pass the options to GemFormattedPrograms.ConfigureTransfers, or set GemFormattedProgramConfiguration.Transfers, 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.

Parameters

Name	Description
MaxCommands	The largest number of commands in one process program that is sent or received in S7F23.
MaxParametersPerCommand	The largest number of parameters (PPARM) in one command.
MaxTotalParameters	The largest number of parameters across all commands of one process program.
MaxTotalParameterBytes	The largest total encoded size, in bytes, of all parameters of one process program.
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

GemFormattedProgramTransferOptions

Constructor

Limits for S7F23/S7F24 formatted process program sends.

public GemFormattedProgramTransferOptions(nuint MaxCommands, nuint MaxParametersPerCommand, nuint MaxTotalParameters, nuint MaxTotalParameterBytes, nuint MaxPending, nuint MaxReceived, nuint MaxResults, nuint MaxHistory)

Pass the options to GemFormattedPrograms.ConfigureTransfers, or set GemFormattedProgramConfiguration.Transfers, 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.

Parameters

Name	Description
MaxCommands	The largest number of commands in one process program that is sent or received in S7F23.
MaxParametersPerCommand	The largest number of parameters (PPARM) in one command.
MaxTotalParameters	The largest number of parameters across all commands of one process program.
MaxTotalParameterBytes	The largest total encoded size, in bytes, of all parameters of one process program.
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.

MaxCommands

Property

The largest number of commands in one process program that is sent or received in S7F23.

public nuint MaxCommands { get; init; }

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; }

MaxParametersPerCommand

Property

The largest number of parameters (PPARM) in one command.

public nuint MaxParametersPerCommand { 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; }

MaxTotalParameterBytes

Property

The largest total encoded size, in bytes, of all parameters of one process program.

public nuint MaxTotalParameterBytes { get; init; }

MaxTotalParameters

Property

The largest number of parameters across all commands of one process program.

public nuint MaxTotalParameters { get; init; }