Message (Windows Web Services)
Zpráva je objekt, který zapouzdřuje data přenášená nebo přijatá. Struktura zprávy je definována protokolem SOAP a obsahuje sadu hlaviček a textu. Hlavičky se vždy ukládají do vyrovnávací paměti, ale tělo se čte a zapisuje pomocí rozhraní API streamování.
Zprávy mají sadu vlastností, které se dají použít k určení volitelných nastavení, která řídí chování zprávy, a poskytují způsob, jak načíst další informace o přijatých zprávách (například informace o zabezpečení). Úplný seznam vlastností zprávy najdete v tématu WS_MESSAGE_PROPERTY_ID.
Zpráva se adresuje konkrétní adrese koncového bodu .
WS_FAULT je speciální druh obsahu zprávy, který představuje chyby vrácené ze vzdáleného koncového bodu.
Zprávy procházejí kódováním, které před přenosem transformuje XML na lineární formát drátu.
Další informace o zprávách najdete v tématu přehledu vrstvy kanálu kanálu.
Následující příklady ilustrují použití zpráv v WWSAPI.
| Příklad | Popis |
|---|---|
| CustomHeaderExample | Ukazuje použití vlastních záhlaví zpráv. |
| MessageEncodingExample | Znázorňuje kódování a dekódování zprávy. |
| ForwardMessageExample | Znázorňuje přeposílání zprávy. |
Následující prvky rozhraní API se používají se zprávami.
| Zpětné volání | Popis |
|---|---|
| WS_MESSAGE_DONE_CALLBACK | Upozorní volajícího, že zpráva dokončila své použití buď WS_XML_READER struktury, která byla zadána wsReadEnvelopeStart funkce, nebo WS_XML_WRITER struktury zadané wsWriteEnvelopeStart funkce. |
| Výčet | Popis |
|---|---|
| WS_ADDRESSING_VERSION | Verze specifikace použité pro hlavičky adresování. |
| WS_ENVELOPE_VERSION | Verze specifikace použité pro strukturu obálky. |
| WS_HEADER_ATTRIBUTES | Sada příznaků, které představují SOAP musíUnderstand a předávat atributy hlavičky. |
| WS_HEADER_TYPE | Typ záhlaví. |
| WS_MESSAGE_INITIALIZATION | Určuje, které hlavičky WsInitializeMessage by se měly přidat do zprávy. |
| WS_MESSAGE_PROPERTY_ID | ID každé vlastnosti zprávy. |
| WS_MESSAGE_STATE | Stav zprávy. |
| Funkce | Popis |
|---|---|
| WsAddressMessage | Přiřadí cílovou adresu ke zprávě. |
| WsCheckMustUnderstandHeaders | Ověří, že příjemce správně pochopil zadané hlavičky. |
| WsCreateMessage | Vytvoří instanci objektu WS_MESSAGE. |
| WsCreateMessageForChannel | Vytvoří zprávu, která je vhodná pro použití s konkrétním kanálem. |
| WsFillBody | Zajišťuje, že je ve zprávě k dispozici dostatečný počet bajtů pro čtení. |
| WsFlushBody | Vyprázdní všechna nahromaděná data textu zprávy, která byla zapsána. |
| WsFreeMessage | Uvolní prostředek paměti přidružený ke zprávě. |
| wsGetCustomHeader | Vyhledá hlavičku zprávy definovanou aplikací a deserializuje ji. |
| wsGetHeader | Najde v zprávě konkrétní standardní hlavičku a deserializuje ji. |
| wsGetHeaderAttributes | Naplní parametr ULONG WS_HEADER_ATTRIBUTES z elementu záhlaví, na kterém je čtečka umístěna. |
| WsGetMessageProperty | Načte zadanou vlastnost objektu Message. |
| WsInitializeMessage | Inicializuje hlavičky zprávy při přípravě na zpracování. |
| WsMarkHeaderAsUnderstood | Označí záhlaví jako pochopitelné aplikací. |
| WsReadBody | Deserializuje hodnotu ze čtečky XML zprávy. |
| WsReadEnvelopeEnd | Přečte zavírací prvky zprávy. |
| wsReadEnvelopeStart | Přečte záhlaví zprávy a připraví se na čtení prvků textu. |
| WsRemoveCustomHeader | Odebere ze zprávy vlastní záhlaví. |
| wsRemoveHeader | Odebere standardní objekt WS_HEADER_TYPE ze zprávy. |
| wsResetMessage | Nastaví stav zprávy zpět na WS_MESSAGE_STATE_EMPTY. |
| wsSetHeader | Přidá nebo nahradí zadanou standardní hlavičku ve zprávě. |
| WsWriteBody | Zapíše hodnotu do textu zprávy. |
| WsWriteEnvelopeEnd | Zapíše zavírací prvky zprávy. |
| WsWriteEnvelopeStart | Zapíše začátek zprávy včetně aktuální sady hlaviček zprávy a připraví se na zápis prvků textu. |
| Klika | Popis |
|---|---|
| WS_MESSAGE | Neprůkazný typ použitý k odkaz na objekt zprávy. |
| Struktura | Popis |
|---|---|
| WS_FAULT | Hodnota chyby přenášená v těle zprávy, která indikuje selhání zpracování. |
| WS_FAULT_CODE | Představuje kód chyby. |
| WS_FAULT_REASON | Obsahuje vysvětlení chyby. |
| WS_MESSAGE_PROPERTIES | Určuje sadu WS_MESSAGE_PROPERTY struktur. |
| WS_MESSAGE_PROPERTY | Určuje konkrétní nastavení zprávy. |