콘텐츠로 이동
무료 평가 시작

PDComm.GemFormattedProgramsWorker

클래스

GEM 작업자의 폴링 스레드에서 정형 프로세스 프로그램 작업을 실행합니다.

public sealed class GemFormattedProgramsWorker

인스턴스는 GemWorker.FormattedPrograms에서 가져옵니다. 각 메서드는 Async 접미사를 뺀 이름이 같은 GemFormattedPrograms 메서드의 비동기 버전입니다.

입력은 명령이 큐에 들어가기 전에 호출 스레드에서 기록됩니다. 문자열, 바이트 버퍼, SecsItem 값은 복사되고, GemResult와 GemFormattedProgramDryRunReport 인수는 대여되므로 호출자가 해제하더라도 명령이 끝날 때까지 네이티브 메모리가 유효합니다. 기록된 바이트는 HsmsWorkerOptions.MaxCommandBytes에 포함됩니다.

멤버

CancelExecutionAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.CancelExecution을 큐에 넣습니다.

public Task<GemFormattedProgramExecutionAction> CancelExecutionAsync(GemFormattedProgramExecutionToken token, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.CancelExecution이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
tokenGemFormattedProgramExecutionStart.Token에서 가져온 실행 토큰입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.CancelExecution이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: token이 null입니다.

ClearCapabilitiesAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ClearCapabilities를 큐에 넣습니다.

public Task<ulong> ClearCapabilitiesAsync(CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ClearCapabilities가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ClearCapabilities가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.

ClearSelectionAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ClearSelection을 큐에 넣습니다.

public Task<bool> ClearSelectionAsync(GemFormattedProgramSelectionToken token, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ClearSelection이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
tokenGemFormattedPrograms.SelectProgram에서 가져온 현재 선택의 토큰입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ClearSelection이 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: token이 null입니다.

CompleteExecutionAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.CompleteExecution을 큐에 넣습니다.

public Task CompleteExecutionAsync(GemFormattedProgramExecutionToken token, ulong reportId, GemFormattedProgramTerminalOutcome outcome, ReadOnlyMemory<byte> detail, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.CompleteExecution이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
tokenGemFormattedProgramExecutionStart.Token에서 가져온 실행 토큰입니다.
reportId결과와 함께 기록되는 애플리케이션 정의 보고서 ID입니다.
outcome프로그램의 최종 결과입니다.
detail결과와 함께 기록되는 애플리케이션 정의 세부 바이트입니다. 최대 끝점 GEM 아이템 한도의 SecsLimits.MessageBytes이며 비어 있을 수 있습니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.CompleteExecution이 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: token이 null입니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

ConfigureCapabilitiesAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ConfigureCapabilities를 큐에 넣습니다.

public Task ConfigureCapabilitiesAsync(GemFormattedProgramCapabilityOptions options, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ConfigureCapabilities가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
options카탈로그 한도와, 서비스의 요청·수신·결과·이력 용량입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ConfigureCapabilities가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: options가 null입니다.

ConfigureQueriesAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ConfigureQueries를 큐에 넣습니다.

public Task ConfigureQueriesAsync(GemFormattedProgramQueryOptions options, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ConfigureQueries가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
options명령 및 매개변수 한도, 저장소 한도, 서비스의 요청·수신·결과·이력 용량입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ConfigureQueries가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: options가 null입니다.

ConfigureTransfersAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ConfigureTransfers를 큐에 넣습니다.

public Task ConfigureTransfersAsync(GemFormattedProgramTransferOptions options, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ConfigureTransfers가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
options명령 및 매개변수 한도와, 서비스의 요청·수신·결과·이력 용량입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ConfigureTransfers가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: options가 null입니다.

ConfigureVerificationNegotiationAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ConfigureVerificationNegotiation을 큐에 넣습니다.

public Task ConfigureVerificationNegotiationAsync(GemFormattedProgramVerificationNegotiationOptions options, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ConfigureVerificationNegotiation이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
options문제 한도, 준비된 협상 용량, 서비스의 요청·수신·결과·이력 용량입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ConfigureVerificationNegotiation이 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: options가 null입니다.

ConfigureVerificationReportsAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ConfigureVerificationReports를 큐에 넣습니다.

public Task ConfigureVerificationReportsAsync(GemFormattedProgramOptions options, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ConfigureVerificationReports가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
options문제 한도와, 서비스의 요청·수신·결과·이력 용량입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ConfigureVerificationReports가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: options가 null입니다.

ConfigureVerificationRequestsAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ConfigureVerificationRequests를 큐에 넣습니다.

public Task ConfigureVerificationRequestsAsync(GemFormattedProgramVerificationRequestOptions options, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ConfigureVerificationRequests가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
options명령 및 매개변수 한도와, 서비스의 요청·수신·결과·이력 용량입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ConfigureVerificationRequests가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: options가 null입니다.

DryRunAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.DryRun을 큐에 넣습니다.

public Task<GemFormattedProgramDryRunReport> DryRunAsync(GemFormattedProgramSelectionToken token, GemFormattedProgramDryRunOptions options, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.DryRun이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
tokenGemFormattedPrograms.SelectProgram에서 가져온 현재 선택의 토큰입니다.
options분석 정책 버전(1이어야 함)과, 문제 수 및 프로그램 인코딩 크기(바이트)의 한도입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.DryRun이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: token 또는 options가 null입니다.

GetExecutionSnapshotAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.GetExecutionSnapshot을 큐에 넣습니다.

public Task<GemFormattedProgramExecutionSnapshot> GetExecutionSnapshotAsync(CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.GetExecutionSnapshot이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.GetExecutionSnapshot이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.

GetSelectionSnapshotAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.GetSelectionSnapshot을 큐에 넣습니다.

public Task<GemFormattedProgramSelectionSnapshot> GetSelectionSnapshotAsync(CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.GetSelectionSnapshot이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.GetSelectionSnapshot이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.

GetStoreInfoAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.GetStoreInfo를 큐에 넣습니다.

public Task<GemFormattedProgramStoreInfo> GetStoreInfoAsync(CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.GetStoreInfo가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.GetStoreInfo가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.

GetStoreSnapshotAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.GetStoreSnapshot을 큐에 넣습니다.

public Task<GemFormattedProgramStoreSnapshot> GetStoreSnapshotAsync(CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.GetStoreSnapshot이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.GetStoreSnapshot이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.

PrepareVerificationAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.PrepareVerification을 큐에 넣습니다.

public Task<GemResult> PrepareVerificationAsync(SecsItem id, IReadOnlyList<GemFormattedProgramIssue> issues, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.PrepareVerification이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
id프로세스 프로그램 ID(PPID)입니다. 비어 있지 않은 최대 120바이트의 ASCII 아이템 또는 Binary 아이템입니다.
issues전송 순서대로 나열한 검증 문제입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.PrepareVerification이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: id 또는 issues가 null이거나 null 값을 포함합니다.
  • ObjectDisposedException 예외: SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

PutProgramAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.PutProgram을 큐에 넣습니다.

public Task PutProgramAsync(GemFormattedProgramPayload payload, GemFormattedProgramStoreAction action, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.PutProgram이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
payload저장할 프로그램입니다. 각 필드의 규칙은 GemFormattedProgramPayload에서 설명합니다.
action프로그램을 쓰는 방식입니다. GemFormattedProgramStoreAction.CreateOnly, GemFormattedProgramStoreAction.ReplaceOnly 또는 GemFormattedProgramStoreAction.Upsert입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.PutProgram이 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: payload가 null이거나 null 값을 포함합니다.
  • ObjectDisposedException 예외: 페이로드 안의 아이템을 포함한 SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

RemoveProgramAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RemoveProgram을 큐에 넣습니다.

public Task<bool> RemoveProgramAsync(SecsItem id, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RemoveProgram이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
id제거할 프로세스 프로그램 ID(PPID)입니다. ASCII 아이템 또는 Binary 아이템입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RemoveProgram이 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: id가 null입니다.
  • ObjectDisposedException 예외: SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

RemoveQueryAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RemoveQuery를 큐에 넣습니다.

public Task<bool> RemoveQueryAsync(SecsItem id, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RemoveQuery가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
id제거할 프로세스 프로그램 ID(PPID)입니다. ASCII 아이템 또는 Binary 아이템입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RemoveQuery가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: id가 null입니다.
  • ObjectDisposedException 예외: SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

ReplaceCapabilitiesAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ReplaceCapabilities를 큐에 넣습니다.

public Task<ulong> ReplaceCapabilitiesAsync(string model, string softwareRevision, byte commandMaximum, uint byteMaximum, IReadOnlyList<GemFormattedProgramCapabilityCommand> commands, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ReplaceCapabilities가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
model장비 모델 유형(MDLN)입니다. 최대 20바이트의 ASCII 텍스트입니다.
softwareRevision소프트웨어 리비전(SOFTREV)입니다. 최대 20바이트의 ASCII 텍스트입니다.
commandMaximum프로그램에 들어갈 수 있는 최대 명령 수(CMDMAX)입니다. U1 아이템으로 전송됩니다.
byteMaximum프로그램을 인코딩한 크기의 최댓값(바이트, BYTMAX)입니다. U4 아이템으로 전송됩니다.
commands전송 순서대로 나열한 명령 항목입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ReplaceCapabilities가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: model, softwareRevision 또는 commands가 null이거나 null 값을 포함합니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RespondCapabilityQueryAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RespondCapabilityQuery를 큐에 넣습니다.

public Task RespondCapabilityQueryAsync(GemResult result, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RespondCapabilityQuery가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션에서 받은 S7F21 요청의 GemResult(GemOutcome.FormattedCapabilityReceived)입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RespondCapabilityQuery가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RespondQueryAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RespondQuery를 큐에 넣습니다.

public Task RespondQueryAsync(GemResult result, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RespondQuery가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션에서 받은 S7F25의 GemResult(GemOutcome.FormattedQueryReceived)입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RespondQuery가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RespondTransferAndStoreAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RespondTransferAndStore를 큐에 넣습니다.

public Task RespondTransferAndStoreAsync(GemResult result, byte acknowledgement, GemFormattedProgramStoreAction action, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RespondTransferAndStore가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션에서 받은 S7F23의 GemResult(GemOutcome.FormattedTransferReceived)입니다.
acknowledgement확인 코드(ACKC7)이며 0~7입니다. 0은 프로그램을 수락합니다.
action프로그램을 저장소에 쓰는 방식입니다. GemFormattedProgramStoreAction.RespondOnly는 쓰지 않고 응답만 합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RespondTransferAndStore가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RespondTransferAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RespondTransfer를 큐에 넣습니다.

public Task RespondTransferAsync(GemResult result, byte acknowledgement, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RespondTransfer가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션에서 받은 S7F23의 GemResult(GemOutcome.FormattedTransferReceived)입니다.
acknowledgement확인 코드(ACKC7)이며 0~7입니다. 0은 프로그램을 수락합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RespondTransfer가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RespondVerificationAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RespondVerification을 큐에 넣습니다.

public Task RespondVerificationAsync(GemResult result, byte grant, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RespondVerification이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션에서 받은 S7F29의 GemResult(GemOutcome.FormattedVerificationInquireReceived)입니다.
grant허가 코드(PPGNT)이며 0~63입니다. 0은 검증 송신을 허가합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RespondVerification이 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RespondVerificationReportAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RespondVerificationReport를 큐에 넣습니다.

public Task RespondVerificationReportAsync(GemResult result, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RespondVerificationReport가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션에서 받은 S7F27의 GemResult(GemOutcome.FormattedVerificationReportReceived)입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RespondVerificationReport가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RespondVerificationRequestAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RespondVerificationRequest를 큐에 넣습니다.

public Task RespondVerificationRequestAsync(GemResult result, byte acknowledgement, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RespondVerificationRequest가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션에서 받은 S7F31의 GemResult(GemOutcome.FormattedVerificationRequestReceived)입니다.
acknowledgement확인 코드(ACKC7)이며 0~7입니다. 0은 요청을 수락합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RespondVerificationRequest가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RetryVerificationAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RetryVerification을 큐에 넣습니다.

public Task<HsmsToken> RetryVerificationAsync(GemResult result, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RetryVerification이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result이 끝점과 세션의 준비된 협상 GemResult이거나, 그 S7F30 허가를 보고한 결과입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RetryVerification이 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

RetryVerificationResponseAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.RetryVerificationResponse를 큐에 넣습니다.

public Task RetryVerificationResponseAsync(GemResult result, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.RetryVerificationResponse가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
result응답을 아직 보내지 않은, 수신한 S7F29의 GemResult(GemOutcome.FormattedVerificationInquireReceived)입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.RetryVerificationResponse가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: result가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

SeedQueryAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SeedQuery를 큐에 넣습니다.

public Task SeedQueryAsync(GemFormattedProgramPayload payload, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SeedQuery가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
payload저장할 프로그램입니다. 각 필드의 규칙은 GemFormattedProgramPayload에서 설명합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SeedQuery가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: payload가 null이거나 null 값을 포함합니다.
  • ObjectDisposedException 예외: 페이로드 안의 아이템을 포함한 SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

SelectProgramAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SelectProgram을 큐에 넣습니다.

public Task<GemFormattedProgramSelectionToken> SelectProgramAsync(SecsItem id, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SelectProgram이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
id로컬 저장소에 있는 프로그램의 프로세스 프로그램 ID(PPID)입니다. ASCII 아이템 또는 Binary 아이템입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SelectProgram이 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: id가 null입니다.
  • ObjectDisposedException 예외: SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

StartExecutionAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.StartExecution을 큐에 넣습니다.

public Task<GemFormattedProgramExecutionStart> StartExecutionAsync(GemFormattedProgramSelectionToken selection, GemFormattedProgramDryRunReport report, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.StartExecution이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
selectionGemFormattedPrograms.SelectProgram이 반환한 토큰입니다. 여전히 현재 선택과 일치해야 합니다.
reportGemFormattedPrograms.DryRun으로 같은 선택에 대해 현재 기능 카탈로그 리비전 기준으로 만든 시험 실행 보고서입니다. 결과가 GemFormattedProgramDryRunOutcome.Reject인 보고서는 거부됩니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.StartExecution이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: selection 또는 report가 null입니다.
  • ObjectDisposedException 예외: GemFormattedProgramDryRunReport 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

StepExecutionAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.StepExecution을 큐에 넣습니다.

public Task<GemFormattedProgramExecutionAction> StepExecutionAsync(GemFormattedProgramExecutionToken token, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.StepExecution이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
tokenGemFormattedProgramExecutionStart.Token에서 가져온 실행 토큰입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.StepExecution이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: token이 null입니다.

SubmitActionResultAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SubmitActionResult를 큐에 넣습니다.

public Task SubmitActionResultAsync(GemFormattedProgramExecutionActionToken token, GemFormattedProgramActionResult result, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SubmitActionResult가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
token대기 중인 동작에 대해 GemFormattedPrograms.GetActionToken에서 가져온 동작 토큰입니다.
result결과입니다. GemFormattedProgramActionResult에서 설명한 대로 동작 종류에 맞아야 합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SubmitActionResult가 작업자의 폴링 스레드에서 실행되면 완료되는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: token이 null입니다.

SubmitCapabilityQueryAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SubmitCapabilityQuery를 큐에 넣습니다.

public Task<HsmsToken> SubmitCapabilityQueryAsync(CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SubmitCapabilityQuery가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SubmitCapabilityQuery가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.

SubmitPreparedVerificationAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SubmitPreparedVerification을 큐에 넣습니다.

public Task<HsmsToken> SubmitPreparedVerificationAsync(GemResult prepared, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SubmitPreparedVerification이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
prepared이 끝점과 세션에서 GemFormattedPrograms.PrepareVerification이 반환한 GemResult입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SubmitPreparedVerification이 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: prepared가 null입니다.
  • ObjectDisposedException 예외: GemResult 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과합니다(PdcommStatus.Backpressure).

SubmitQueryAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SubmitQuery를 큐에 넣습니다.

public Task<HsmsToken> SubmitQueryAsync(SecsItem id, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SubmitQuery가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
id요청할 프로세스 프로그램 ID(PPID)입니다. 비어 있지 않은 최대 120바이트의 ASCII 아이템 또는 Binary 아이템입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SubmitQuery가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: id가 null입니다.
  • ObjectDisposedException 예외: SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

SubmitTransferAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SubmitTransfer를 큐에 넣습니다.

public Task<HsmsToken> SubmitTransferAsync(GemFormattedProgramPayload payload, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SubmitTransfer가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
payload보낼 프로그램입니다. 각 필드의 규칙은 GemFormattedProgramPayload에서 설명합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SubmitTransfer가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: payload가 null이거나 null 값을 포함합니다.
  • ObjectDisposedException 예외: 페이로드 안의 아이템을 포함한 SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

SubmitVerificationReportAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SubmitVerificationReport를 큐에 넣습니다.

public Task<HsmsToken> SubmitVerificationReportAsync(SecsItem id, IReadOnlyList<GemFormattedProgramIssue> issues, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SubmitVerificationReport가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
id프로세스 프로그램 ID(PPID)입니다. 비어 있지 않은 최대 120바이트의 ASCII 아이템 또는 Binary 아이템입니다.
issues전송 순서대로 나열한 검증 문제입니다. 빈 목록을 전달하면 빈 문제 목록을 보냅니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SubmitVerificationReport가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: id 또는 issues가 null이거나 null 값을 포함합니다.
  • ObjectDisposedException 예외: SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

SubmitVerificationRequestAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.SubmitVerificationRequest를 큐에 넣습니다.

public Task<HsmsToken> SubmitVerificationRequestAsync(GemFormattedProgramPayload payload, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 찼거나 이벤트 출력이 막혀 있으면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.SubmitVerificationRequest가 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
payload검증할 프로그램입니다. 각 필드의 규칙은 GemFormattedProgramPayload에서 설명합니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.SubmitVerificationRequest가 반환한 값을 결과로 갖는 작업입니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: payload가 null이거나 null 값을 포함합니다.
  • ObjectDisposedException 예외: 페이로드 안의 아이템을 포함한 SecsItem 인수가 해제되었습니다.
  • PdcommException 예외: 기록된 입력이 작업자의 명령 바이트 예산을 초과했거나(PdcommStatus.Backpressure), 기록된 아이템이 작업자의 아이템 한도를 초과합니다.

ValidateSelectionAsync

메서드

작업자의 폴링 스레드에서 실행하도록 GemFormattedPrograms.ValidateSelection을 큐에 넣습니다.

public Task<GemFormattedProgramSelectionSnapshot> ValidateSelectionAsync(GemFormattedProgramSelectionToken token, CancellationToken cancellationToken = default)

작업자의 명령 큐나 바이트 예산이 가득 차면 PdcommException과 PdcommStatus.Backpressure로, 작업자가 명령 수락을 멈춘 뒤에는 ObjectDisposedException으로, 그 밖에는 GemFormattedPrograms.ValidateSelection이 throw한 예외로 작업이 실패합니다. 명령이 실행되기 전에 cancellationToken이 취소되면 작업이 취소됩니다.

매개변수

이름설명
tokenGemFormattedPrograms.SelectProgram에서 가져온 현재 선택의 토큰입니다.
cancellationToken아직 실행을 시작하지 않은 명령을 취소하는 토큰입니다.

반환값

GemFormattedPrograms.ValidateSelection이 반환한 값을 결과로 갖는 작업입니다. 호출자가 반환된 객체를 소유하며 해제해야 합니다.

참고

  • OperationCanceledException 예외: cancellationToken이 이미 취소되었습니다.
  • ArgumentNullException 예외: token이 null입니다.