Pesan (Windows Web Services)

Pesan adalah objek yang merangkum data yang dikirimkan atau diterima. Struktur pesan didefinisikan oleh SOAP dan menyertakan sekumpulan header dan isi. Header selalu di-buffer dalam memori, tetapi isinya dibaca dan ditulis dengan API streaming.

Diagram showing a message with the header being buffered and the body being streamed.

Pesan memiliki sekumpulan properti yang dapat digunakan untuk menentukan pengaturan opsional yang mengontrol perilaku pesan, dan untuk menyediakan cara untuk mengambil informasi tambahan tentang pesan yang diterima (seperti informasi keamanan). Lihat WS_MESSAGE_PROPERTY_ID untuk daftar lengkap properti pesan.

Pesan ditujukan ke Alamat Titik Akhir tertentu.

WS_FAULT adalah jenis konten pesan khusus yang digunakan untuk mewakili kegagalan yang dikembalikan dari titik akhir jarak jauh.

Pesan menjalani pengodean yang mengubah XML ke format kawat linier sebelum ditransmisikan.

Untuk informasi selengkapnya tentang pesan, lihat topik Gambaran Umum Lapisan Saluran.

Contoh berikut mengilustrasikan menggunakan pesan di WWSAPI.

Contoh Deskripsi
CustomHeaderExample Mengilustrasikan menggunakan header pesan kustom.
MessageEncodingExample Mengilustrasikan pengodean dan pendekodean pesan.
ForwardMessageExample Mengilustrasikan penerusan pesan.

 

Elemen API berikut digunakan dengan pesan.

Panggilan balik Deskripsi
WS_MESSAGE_DONE_CALLBACK Memberi tahu pemanggil bahwa pesan telah menyelesaikan penggunaannya dari struktur WS_XML_READER yang disediakan ke fungsi WsReadEnvelopeStart, atau struktur WS_XML_WRITER yang disediakan ke fungsi WsWriteEnvelopeStart.

 

Enumeration Deskripsi
WS_ADDRESSING_VERSION Versi spesifikasi yang digunakan untuk header alamat.
WS_ENVELOPE_VERSION Versi spesifikasi yang digunakan untuk struktur amplop.
WS_HEADER_ATTRIBUTES Sekumpulan bendera yang mewakili atribut SOAP mustUnderstand dan relay header.
WS_HEADER_TYPE Jenis header.
WS_MESSAGE_INITIALIZATION Menentukan header apa yang harus ditambahkan WsInitializeMessage ke pesan.
WS_MESSAGE_PROPERTY_ID ID setiap properti pesan.
WS_MESSAGE_STATE Status pesan.

 

Function Deskripsi
WsAddressMessage Menetapkan alamat tujuan ke pesan.
WsCheckMustUnderstandHeaders Memverifikasi bahwa header yang ditentukan dipahami dengan tepat oleh penerima.
WsCreateMessage Membuat instans objek WS_MESSAGE .
WsCreateMessageForChannel Membuat pesan yang sesuai untuk digunakan dengan saluran tertentu.
WsFillBody Memastikan bahwa ada cukup banyak byte yang tersedia dalam pesan untuk dibaca.
WsFlushBody Bersihkan semua akumulasi data isi pesan yang telah ditulis.
WsFreeMessage Merilis sumber daya memori yang terkait dengan pesan.
WsGetCustomHeader Menemukan header pesan yang ditentukan aplikasi dan mendeserialisasinya.
WsGetHeader Menemukan header standar tertentu dalam pesan dan mendeserialisasinya.
WsGetHeaderAttributes Mengisi parameter ULONG dengan WS_HEADER_ATTRIBUTES dari elemen header tempat pembaca diposisikan.
WsGetMessageProperty Mengambil properti objek Pesan tertentu.
WsInitializeMessage Menginisialisasi header untuk pesan sebagai persiapan untuk diproses.
WsMarkHeaderAsUnderstood Menandai header sebagai dipahami oleh aplikasi.
WsReadBody Mendeserialisasi nilai dari Pembaca XML pesan.
WsReadEnvelopeEnd Membaca elemen penutup pesan.
WsReadEnvelopeStart Membaca header pesan dan bersiap untuk membaca elemen isi.
WsRemoveCustomHeader Menghapus header kustom dari pesan.
WsRemoveHeader Menghapus objek WS_HEADER_TYPE standar dari pesan.
WsResetMessage Mengatur kembali status Pesan ke WS_MESSAGE_STATE_EMPTY.
WsSetHeader Menambahkan atau mengganti header standar yang ditentukan dalam pesan.
WsWriteBody Menulis nilai dalam isi pesan.
WsWriteEnvelopeEnd Menulis elemen penutup pesan.
WsWriteEnvelopeStart Menulis awal pesan termasuk sekumpulan header pesan saat ini dan bersiap untuk menulis elemen isi.

 

Penanganan Deskripsi
WS_MESSAGE Jenis buram yang digunakan untuk mereferensikan objek pesan.

 

Struktur Deskripsi
WS_FAULT Nilai kesalahan yang dibawa dalam isi pesan yang menunjukkan kegagalan pemrosesan.
WS_FAULT_CODE Mewakili kode kesalahan.
WS_FAULT_REASON Berisi penjelasan tentang kesalahan.
WS_MESSAGE_PROPERTIES Menentukan sekumpulan struktur WS_MESSAGE_PROPERTY .
WS_MESSAGE_PROPERTY Menentukan pengaturan khusus pesan.