Win32 API 日本語リファレンス
ホームDevices.WebServicesOnDevices › WSD_APP_SEQUENCE

WSD_APP_SEQUENCE

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

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

フィールド

フィールドサイズx64x86説明
InstanceIdULONGLONG8+0+0インスタンス識別子です。
SequenceIdLPWSTR8/4+8+8シーケンス識別子です。
MessageNumberULONGLONG8+16+16メッセージ番号です。

公式ドキュメント

WS-Discovery メッセージに関連するアプリケーションシーケンス情報を表します。

解説(Remarks)

アプリケーションシーケンスヘッダーブロックにより、受信側は、このヘッダーブロックを含むメッセージが順不同で受信された場合でも、その順序を維持できます。これにより、ターゲットサービスからの Hello メッセージおよび Bye メッセージを正しく順序付けできます。

アプリケーションシーケンスヘッダーブロックの規定のアウトラインは次のとおりです。

<s:Envelope ...>
  <s:Header ...>
    <d:AppSequence InstanceId='xs:nonNegativeInteger' [SequenceId='xs:anyURI']? MessageNumber='xs:nonNegativeInteger' ... />
  </s:Header>
  <s:Body ...> ...
  </s:Body>
</s:Envelope>

以下では、このアウトラインの規定の制約について説明します。

/s:Envelope/s:Header/d:AppSequence/@InstanceId

この設定は、サービスが終了して状態を失い、復元されるたびに、少なくとも 1 以上の値だけ増分しなければなりません。アプリケーションは、サービスが再起動されるたびに増分されるカウンターを使用して、この値を設定できます。サービスの再起動時刻は、1970 年 1 月 1 日午前 0 時からの経過秒数で表されます。

/s:Envelope/s:Header/d:AppSequence/@SequenceId

この設定は、インスタンス識別子のコンテキスト内でシーケンスを識別します。省略された場合、暗黙の値は null シーケンスです。この設定の値は ./@InstanceId 内で一意でなければなりません。

/s:Envelope/s:Header/d:AppSequence/@MessageNumber

この設定は、シーケンス識別子およびインスタンス識別子のコンテキスト内でメッセージを識別します。送信するメッセージごとに、少なくとも 1 以上の値だけ増分しなければなりません。トランスポートレベルでこのメッセージを再送信する場合も、この値を維持しなければなりません。

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

各言語での定義

#include <windows.h>

// WSD_APP_SEQUENCE  (x64 24 / x86 24 バイト)
typedef struct WSD_APP_SEQUENCE {
    ULONGLONG InstanceId;
    LPWSTR SequenceId;
    ULONGLONG MessageNumber;
} WSD_APP_SEQUENCE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WSD_APP_SEQUENCE
{
    public ulong InstanceId;
    public IntPtr SequenceId;
    public ulong MessageNumber;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WSD_APP_SEQUENCE
    Public InstanceId As ULong
    Public SequenceId As IntPtr
    Public MessageNumber As ULong
End Structure
import ctypes
from ctypes import wintypes

class WSD_APP_SEQUENCE(ctypes.Structure):
    _fields_ = [
        ("InstanceId", ctypes.c_ulonglong),
        ("SequenceId", ctypes.c_void_p),
        ("MessageNumber", ctypes.c_ulonglong),
    ]
#[repr(C)]
pub struct WSD_APP_SEQUENCE {
    pub InstanceId: u64,
    pub SequenceId: *mut core::ffi::c_void,
    pub MessageNumber: u64,
}
import "golang.org/x/sys/windows"

type WSD_APP_SEQUENCE struct {
	InstanceId uint64
	SequenceId uintptr
	MessageNumber uint64
}
type
  WSD_APP_SEQUENCE = record
    InstanceId: UInt64;
    SequenceId: Pointer;
    MessageNumber: UInt64;
  end;
const WSD_APP_SEQUENCE = extern struct {
    InstanceId: u64,
    SequenceId: ?*anyopaque,
    MessageNumber: u64,
};
type
  WSD_APP_SEQUENCE {.bycopy.} = object
    InstanceId: uint64
    SequenceId: pointer
    MessageNumber: uint64
struct WSD_APP_SEQUENCE
{
    ulong InstanceId;
    void* SequenceId;
    ulong MessageNumber;
}

HSP用 定義

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

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

stdim st, WSD_APP_SEQUENCE        ; NSTRUCT 変数を確保
st->InstanceId = 100
mes "InstanceId=" + st->InstanceId