libUPnP
1.8.0
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
upnp
src
inc
soaplib.h
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
//
31
32
#ifndef SOAPLIB_H
33
#define SOAPLIB_H
34
35
36
// SOAP module API to be called in Upnp-Dk API
37
/****************************************************************************
38
* Function : soap_device_callback
39
*
40
* Parameters :
41
* IN http_parser_t *parser : Parsed request received by the device
42
* IN http_message_t* request : HTTP request
43
* INOUT SOCKINFO *info : socket info
44
*
45
* Description : This is a callback called by minisever after receiving
46
* the request from the control point. This function will start
47
* processing the request. It calls handle_invoke_action to handle the
48
* SOAP action
49
*
50
* Return : void
51
*
52
* Note :
53
****************************************************************************/
54
void
soap_device_callback(
55
IN
http_parser_t
*parser,
56
IN
http_message_t
* request,
57
INOUT
SOCKINFO
*info );
58
59
60
/****************************************************************************
61
* Function : SoapSendAction
62
*
63
* Parameters :
64
* IN char* action_url : device contrl URL
65
* IN char *service_type : device service type
66
* IN IXML_Document *action_node : SOAP action node
67
* OUT IXML_Document **response_node : SOAP response node
68
*
69
* Description : This function is called by UPnP API to send the SOAP
70
* action request and waits till it gets the response from the device
71
* pass the response to the API layer
72
*
73
* Return : int
74
* returns UPNP_E_SUCCESS if successful else returns appropriate error
75
* Note :
76
****************************************************************************/
77
int
SoapSendAction(
78
IN
char
* action_url,
79
IN
char
*service_type,
80
IN
IXML_Document
*action_node,
81
OUT
IXML_Document
**response_node );
82
83
/****************************************************************************
84
* Function : SoapSendActionEx
85
*
86
* Parameters :
87
* IN char* action_url : device contrl URL
88
* IN char *service_type : device service type
89
IN IXML_Document *Header: Soap header
90
* IN IXML_Document *action_node : SOAP action node ( SOAP body)
91
* OUT IXML_Document **response_node : SOAP response node
92
*
93
* Description : This function is called by UPnP API to send the SOAP
94
* action request and waits till it gets the response from the device
95
* pass the response to the API layer. This action is similar to the
96
* the SoapSendAction with only difference that it allows users to
97
* pass the SOAP header along the SOAP body ( soap action request)
98
*
99
* Return : int
100
* returns UPNP_E_SUCCESS if successful else returns appropriate error
101
* Note :
102
****************************************************************************/
103
int
SoapSendActionEx(
104
IN
char
* ActionURL,
105
IN
char
*ServiceType,
106
IN
IXML_Document
*Header,
107
IN
IXML_Document
*ActNode ,
108
OUT
IXML_Document
**RespNode) ;
109
110
/****************************************************************************
111
* Function : SoapGetServiceVarStatus
112
*
113
* Parameters :
114
* IN char * action_url : Address to send this variable
115
* query message.
116
* IN char *var_name : Name of the variable.
117
* OUT char **var_value : Output value.
118
*
119
* Description : This function creates a status variable query message
120
* send it to the specified URL. It also collect the response.
121
*
122
* Return : int
123
*
124
* Note :
125
****************************************************************************/
126
int
SoapGetServiceVarStatus(
127
IN
char
* ActionURL,
128
IN
DOMString
VarName,
129
OUT
DOMString
*StVar) ;
130
131
extern
const
char
* ContentTypeHeader;
132
133
#endif //SOAPLIB_H
Generated on Sat Nov 1 2014 20:42:25 for libUPnP by
1.8.1.2