libUPnP
1.14.19
upnp
src
inc
soaplib.h
Go to the documentation of this file.
1
/**************************************************************************
2
*
3
* Copyright (c) 2000-2003 Intel Corporation
4
* All rights reserved.
5
*
6
* Redistribution and use in source and binary forms, with or without
7
* modification, are permitted provided that the following conditions are met:
8
*
9
* - Redistributions of source code must retain the above copyright notice,
10
* this list of conditions and the following disclaimer.
11
* - Redistributions in binary form must reproduce the above copyright notice,
12
* this list of conditions and the following disclaimer in the documentation
13
* and/or other materials provided with the distribution.
14
* - Neither name of Intel Corporation nor the names of its contributors
15
* may be used to endorse or promote products derived from this software
16
* without specific prior written permission.
17
*
18
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
22
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
*
30
**************************************************************************/
31
32
#ifndef SOAPLIB_H
33
#define SOAPLIB_H
34
39
/* SOAP module API to be called in Upnp-Dk API */
40
41
#include "
sock.h
"
42
48
void
soap_device_callback
(
50
http_parser_t
*parser,
52
http_message_t
*request,
54
SOCKINFO
*info);
55
56
/****************************************************************************
57
* Function: SoapSendAction
58
*
59
* Parameters:
60
* IN char* action_url: device contrl URL
61
* IN char *service_type: device service type
62
* IN IXML_Document *action_node: SOAP action node
63
* OUT IXML_Document **response_node: SOAP response node
64
*
65
* Description: This function is called by UPnP API to send the SOAP
66
* action request and waits till it gets the response from the device
67
* pass the response to the API layer
68
*
69
* Return: int
70
* returns UPNP_E_SUCCESS if successful else returns appropriate error
71
* Note:
72
****************************************************************************/
73
int
SoapSendAction(
char
*action_url,
74
char
*service_type,
75
IXML_Document
*action_node,
76
IXML_Document
**response_node);
77
78
/****************************************************************************
79
* Function: SoapSendActionEx
80
*
81
* Parameters:
82
* IN char* action_url: device contrl URL
83
* IN char *service_type: device service type
84
* IN IXML_Document *Header: Soap header
85
* IN IXML_Document *action_node: SOAP action node (SOAP body)
86
* OUT IXML_Document **response_node: SOAP response node
87
*
88
* Description: This function is called by UPnP API to send the SOAP
89
* action request and waits till it gets the response from the device
90
* pass the response to the API layer. This action is similar to the
91
* the SoapSendAction with only difference that it allows users to
92
* pass the SOAP header along the SOAP body ( soap action request)
93
*
94
* Return: int
95
* returns UPNP_E_SUCCESS if successful else returns appropriate error
96
* Note:
97
****************************************************************************/
98
int
SoapSendActionEx(
char
*ActionURL,
99
char
*ServiceType,
100
IXML_Document
*Header,
101
IXML_Document
*ActNode,
102
IXML_Document
**RespNode);
103
104
/****************************************************************************
105
* Function: SoapGetServiceVarStatus
106
*
107
* Parameters:
108
* IN char * action_url: Address to send this variable query message.
109
* IN char *var_name: Name of the variable.
110
* OUT char **var_value: Output value.
111
*
112
* Description: This function creates a status variable query message
113
* send it to the specified URL. It also collect the response.
114
*
115
* Return: int
116
*
117
* Note:
118
****************************************************************************/
119
int
SoapGetServiceVarStatus(
120
char
*ActionURL,
DOMString
VarName,
DOMString
*StVar);
121
122
extern
const
char
*ContentTypeHeader;
123
124
#endif
/* SOAPLIB_H */
DOMString
#define DOMString
The type of DOM strings.
Definition
ixml.h:48
soap_device_callback
void soap_device_callback(http_parser_t *parser, http_message_t *request, SOCKINFO *info)
This is a callback called by minisever after receiving the request from the control point....
Definition
soap_device.c:743
sock.h
SOCKINFO
Definition
sock.h:60
_IXML_Document
Data structure representing the DOM Document.
Definition
ixml.h:160
http_message_t
Definition
httpparser.h:182
http_parser_t
Definition
httpparser.h:217
Generated by
1.9.8