Win32 API 日本語リファレンス
ホームSystem.JobObjects › JOBOBJECT_ASSOCIATE_COMPLETION_PORT

JOBOBJECT_ASSOCIATE_COMPLETION_PORT

構造体
サイズx64: 16 バイト / x86: 8 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
CompletionKeyvoid*8/4+0+0ジョブのためにメッセージが送信されるときに PostQueuedCompletionStatusdwCompletionKey パラメーターで使用する値です。
CompletionPortHANDLE8/4+8+4

ジョブのためにメッセージが送信されるときに PostQueuedCompletionStatus 関数の CompletionPort パラメーターで使用する完了ポートです。

Windows 8 以降、Windows Server 2012 以降: 現在の完了ポートとジョブとの関連付けを解除するには、NULL を指定します。

公式ドキュメント

完了ポートをジョブに関連付けるために使用される情報を格納します。1 つのジョブに関連付けられる完了ポートは 1 つです。

解説(Remarks)

特定のイベントが発生すると、システムはジョブに関連付けられている I/O 完了ポートにメッセージを送信します。ジョブが入れ子になっている場合、メッセージは、そのメッセージを発生させたジョブの親ジョブ チェーン内のいずれかのジョブに関連付けられているすべての I/O 完了ポートに送信されます。すべてのメッセージは、ジョブが PostQueuedCompletionStatus 関数を呼び出したかのように、ジョブから直接送信されます。

JobObjectNotificationLimitInformation 情報クラスで設定された制限を除き、メッセージは通知のみを目的としており、完了ポートへの配信は保証されないことに注意してください。メッセージが完了ポートに到着しなかったとしても、必ずしもそのイベントが発生しなかったことを意味するわけではありません。JobObjectNotificationLimitInformation で設定された制限に関する通知は、完了ポートに到着することが保証されます。

メッセージを受け取るには、スレッドが GetQueuedCompletionStatus 関数を使用して完了ポートを監視する必要があります。スレッドは、次の表に示す GetQueuedCompletionStatus のパラメーターで情報を受け取ります。

パラメーター 受け取る情報
lpCompletionKey 完了ポートの関連付け時に CompletionKey に指定した値です。1 つの完了ポートが複数のジョブに関連付けられている場合、CompletionKey は、どの完了ポートがメッセージを送信しているかを呼び出し側が判別するのに役立ちます。
lpOverlapped メッセージ固有の値です。詳細については、後述のメッセージ識別子の表を参照してください。
LpNumberOfBytes どのジョブ関連イベントが発生したかを示すメッセージ識別子です。詳細については、後述のメッセージ識別子の表を参照してください。

完了ポートには次のメッセージが送信されることがあります。プロセス識別子を返すメッセージについては、そのプロセスへのオープン ハンドルを保持し続けない限り、そのプロセスがまだアクティブであることや、識別子が再利用(終了後に新しいプロセスへ割り当て)されていないことを保証できない点に注意してください。

メッセージ識別子 説明
JOB_OBJECT_MSG_ABNORMAL_EXIT_PROCESS ジョブに関連付けられたプロセスが、異常終了を示す終了コード(この表の後の一覧を参照)で終了したことを示します。

lpOverlapped の値は、終了したプロセスの識別子です。

JOB_OBJECT_MSG_ACTIVE_PROCESS_LIMIT アクティブ プロセス数の制限を超えたことを示します。

lpOverlapped の値は NULL です。

JOB_OBJECT_MSG_ACTIVE_PROCESS_ZERO アクティブ プロセス数が 0 まで減少したことを示します。たとえば、ジョブに現在 2 つのアクティブ プロセスがある場合、システムは両方が終了した後にこのメッセージを送信します。

lpOverlapped の値は NULL です。

JOB_OBJECT_MSG_END_OF_JOB_TIME JOB_OBJECT_POST_AT_END_OF_JOB オプションが有効で、ジョブ終了時間制限に達したことを示します。このメッセージの送信をもって時間制限は取り消され、ジョブのプロセスは実行を継続できます。

lpOverlapped の値は NULL です。

JOB_OBJECT_MSG_END_OF_PROCESS_TIME プロセスがプロセスごとの時間制限を超えたことを示します。システムは、プロセスの終了が要求された後にこのメッセージを送信します。

lpOverlapped の値は、制限を超えたプロセスの識別子です。

JOB_OBJECT_MSG_EXIT_PROCESS ジョブに関連付けられたプロセスが終了したことを示します。

lpOverlapped の値は、終了したプロセスの識別子です。

JOB_OBJECT_MSG_JOB_MEMORY_LIMIT ジョブに関連付けられたプロセスが原因で、ジョブ全体のメモリ制限(有効な場合)を超えたことを示します。

lpOverlapped の値は、制限を超えようとしたプロセスの識別子を指定します。プロセスがまだ自身のプロセス識別子を報告していない場合、システムはこのメッセージを送信しません。

JOB_OBJECT_MSG_NEW_PROCESS プロセスがジョブに追加されたことを示します。完了ポートを関連付けた時点でジョブに追加されていたプロセスも報告されます。

lpOverlapped の値は、ジョブに追加されたプロセスの識別子です。

JOB_OBJECT_MSG_NOTIFICATION_LIMIT リソース制限通知を登録しているジョブに関連付けられたプロセスが、1 つ以上の制限を超えたことを示します。どの制限を超えたかを判断するには、JobObjectLimitViolationInformation を指定して QueryInformationJobObject 関数を使用します。

lpOverlapped の値は、制限を超えたプロセスの識別子です。プロセスがまだ自身のプロセス識別子を報告していない場合、システムはこのメッセージを送信しません。

JOB_OBJECT_MSG_PROCESS_MEMORY_LIMIT ジョブに関連付けられたプロセスが、そのプロセスのメモリ制限(有効な場合)を超えたことを示します。

lpOverlapped の値は、制限を超えたプロセスの識別子です。プロセスがまだ自身のプロセス識別子を報告していない場合、システムはこのメッセージを送信しません。

次の終了コードは異常終了を示します。

JOB_OBJECT_MSG_NEW_PROCESS および JOB_OBJECT_MSG_EXIT_PROCESS メッセージを使用する際は、競合状態が発生する可能性があるため注意が必要です。たとえば、ジョブ内でプロセスが盛んに開始・終了している最中に、そのジョブへ完了ポートを割り当てている場合、完了ポートの関連付け中に状態が変化したプロセスのメッセージを取りこぼす可能性があります。このため、完了ポートのジョブへの関連付けは、ジョブが非アクティブなときに行うのが最善です。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// JOBOBJECT_ASSOCIATE_COMPLETION_PORT  (x64 16 / x86 8 バイト)
typedef struct JOBOBJECT_ASSOCIATE_COMPLETION_PORT {
    void* CompletionKey;
    HANDLE CompletionPort;
} JOBOBJECT_ASSOCIATE_COMPLETION_PORT;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct JOBOBJECT_ASSOCIATE_COMPLETION_PORT
{
    public IntPtr CompletionKey;
    public IntPtr CompletionPort;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure JOBOBJECT_ASSOCIATE_COMPLETION_PORT
    Public CompletionKey As IntPtr
    Public CompletionPort As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class JOBOBJECT_ASSOCIATE_COMPLETION_PORT(ctypes.Structure):
    _fields_ = [
        ("CompletionKey", ctypes.c_void_p),
        ("CompletionPort", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct JOBOBJECT_ASSOCIATE_COMPLETION_PORT {
    pub CompletionKey: *mut core::ffi::c_void,
    pub CompletionPort: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type JOBOBJECT_ASSOCIATE_COMPLETION_PORT struct {
	CompletionKey uintptr
	CompletionPort uintptr
}
type
  JOBOBJECT_ASSOCIATE_COMPLETION_PORT = record
    CompletionKey: Pointer;
    CompletionPort: Pointer;
  end;
const JOBOBJECT_ASSOCIATE_COMPLETION_PORT = extern struct {
    CompletionKey: ?*anyopaque,
    CompletionPort: ?*anyopaque,
};
type
  JOBOBJECT_ASSOCIATE_COMPLETION_PORT {.bycopy.} = object
    CompletionKey: pointer
    CompletionPort: pointer
struct JOBOBJECT_ASSOCIATE_COMPLETION_PORT
{
    void* CompletionKey;
    void* CompletionPort;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; JOBOBJECT_ASSOCIATE_COMPLETION_PORT サイズ: 8 バイト(x86)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; CompletionKey : void* (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; CompletionPort : HANDLE (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; JOBOBJECT_ASSOCIATE_COMPLETION_PORT サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; CompletionKey : void* (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; CompletionPort : HANDLE (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global JOBOBJECT_ASSOCIATE_COMPLETION_PORT
    #field intptr CompletionKey
    #field intptr CompletionPort
#endstruct

stdim st, JOBOBJECT_ASSOCIATE_COMPLETION_PORT        ; NSTRUCT 変数を確保