generic-library/libupnp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Whitespace fix on soaplib.h.

Browse Source 
(cherry picked from commit 95f7a7eeef8717b4d04b68cfcc3dddab13a7cff8)
This commit is contained in:
Marcelo Roberto Jimenez 2010-10-02 18:57:35 -03:00
parent fec0dd041b
commit efb5d0cadf
1 changed files with 116 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

230
upnp/src/inc/soaplib.h
View File

@ -1,133 +1,135 @@
/////////////////////////////////////////////////////////////////////////// /**************************************************************************
// *
// Copyright (c) 2000-2003 Intel Corporation * Copyright (c) 2000-2003 Intel Corporation
// All rights reserved. * All rights reserved.
// *
// Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met: * modification, are permitted provided that the following conditions are met:
// *
// * Redistributions of source code must retain the above copyright notice, * - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. * this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice, * - Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation * this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution. * and/or other materials provided with the distribution.
// * Neither name of Intel Corporation nor the names of its contributors * - Neither name of Intel Corporation nor the names of its contributors
// may be used to endorse or promote products derived from this software * may be used to endorse or promote products derived from this software
// without specific prior written permission. * without specific prior written permission.
// *
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// *
/////////////////////////////////////////////////////////////////////////// **************************************************************************/
#ifndef SOAPLIB_H #ifndef SOAPLIB_H
#define SOAPLIB_H #define SOAPLIB_H
// SOAP module API to be called in Upnp-Dk API /* SOAP module API to be called in Upnp-Dk API */
/**************************************************************************** /****************************************************************************
* Function : soap_device_callback * Function: soap_device_callback
* *
* Parameters : * Parameters:
* IN http_parser_t *parser : Parsed request received by the device * IN http_parser_t *parser: Parsed request received by the device
* IN http_message_t* request : HTTP request * IN http_message_t* request: HTTP request
* INOUT SOCKINFO *info : socket info * INOUT SOCKINFO *info: socket info
* *
* Description : This is a callback called by minisever after receiving * Description: This is a callback called by minisever after receiving
* the request from the control point. This function will start * the request from the control point. This function will start
* processing the request. It calls handle_invoke_action to handle the * processing the request. It calls handle_invoke_action to handle the
* SOAP action * SOAP action
* *
* Return : void * Return: void
* *
* Note : * Note:
****************************************************************************/ ****************************************************************************/
void soap_device_callback( void soap_device_callback(
IN http_parser_t *parser, IN http_parser_t *parser,
IN http_message_t* request, IN http_message_t* request,
INOUT SOCKINFO *info ); INOUT SOCKINFO *info);
/**************************************************************************** /****************************************************************************
* Function : SoapSendAction * Function: SoapSendAction
* *
* Parameters : * Parameters:
* IN char* action_url : device contrl URL * IN char* action_url: device contrl URL
* IN char *service_type : device service type * IN char *service_type: device service type
* IN IXML_Document *action_node : SOAP action node * IN IXML_Document *action_node: SOAP action node
* OUT IXML_Document **response_node : SOAP response node * OUT IXML_Document **response_node: SOAP response node
* *
* Description : This function is called by UPnP API to send the SOAP * Description: This function is called by UPnP API to send the SOAP
* action request and waits till it gets the response from the device * action request and waits till it gets the response from the device
* pass the response to the API layer * pass the response to the API layer
* *
* Return : int * Return: int
* returns UPNP_E_SUCCESS if successful else returns appropriate error * returns UPNP_E_SUCCESS if successful else returns appropriate error
* Note : * Note:
****************************************************************************/ ****************************************************************************/
int SoapSendAction( int SoapSendAction(
IN char* action_url, IN char* action_url,
IN char *service_type, IN char *service_type,
IN IXML_Document *action_node, IN IXML_Document *action_node,
OUT IXML_Document **response_node ); OUT IXML_Document **response_node);
/**************************************************************************** /****************************************************************************
* Function : SoapSendActionEx * Function: SoapSendActionEx
* *
* Parameters : * Parameters:
* IN char* action_url : device contrl URL * IN char* action_url: device contrl URL
* IN char *service_type : device service type * IN char *service_type: device service type
IN IXML_Document *Header: Soap header * IN IXML_Document *Header: Soap header
* IN IXML_Document *action_node : SOAP action node ( SOAP body) * IN IXML_Document *action_node: SOAP action node (SOAP body)
* OUT IXML_Document **response_node : SOAP response node * OUT IXML_Document **response_node: SOAP response node
* *
* Description : This function is called by UPnP API to send the SOAP * Description: This function is called by UPnP API to send the SOAP
* action request and waits till it gets the response from the device * action request and waits till it gets the response from the device
* pass the response to the API layer. This action is similar to the * pass the response to the API layer. This action is similar to the
* the SoapSendAction with only difference that it allows users to * the SoapSendAction with only difference that it allows users to
* pass the SOAP header along the SOAP body ( soap action request) * pass the SOAP header along the SOAP body ( soap action request)
* *
* Return : int * Return: int
* returns UPNP_E_SUCCESS if successful else returns appropriate error * returns UPNP_E_SUCCESS if successful else returns appropriate error
* Note : * Note:
****************************************************************************/ ****************************************************************************/
int SoapSendActionEx( int SoapSendActionEx(
IN char * ActionURL, IN char * ActionURL,
IN char *ServiceType, IN char *ServiceType,
IN IXML_Document *Header, IN IXML_Document *Header,
IN IXML_Document *ActNode , IN IXML_Document *ActNode,
OUT IXML_Document **RespNode) ; OUT IXML_Document **RespNode);
/**************************************************************************** /****************************************************************************
* Function : SoapGetServiceVarStatus * Function: SoapGetServiceVarStatus
* *
* Parameters : * Parameters:
* IN char * action_url : Address to send this variable * IN char * action_url: Address to send this variable query message.
* query message. * IN char *var_name: Name of the variable.
* IN char *var_name : Name of the variable. * OUT char **var_value: Output value.
* OUT char **var_value : Output value. *
* * Description: This function creates a status variable query message
* Description : This function creates a status variable query message * send it to the specified URL. It also collect the response.
* send it to the specified URL. It also collect the response. *
* * Return: int
* Return : int *
* * Note:
* Note : ****************************************************************************/
****************************************************************************/
int SoapGetServiceVarStatus( int SoapGetServiceVarStatus(
IN char * ActionURL, IN char * ActionURL,
IN DOMString VarName, IN DOMString VarName,
OUT DOMString *StVar) ; OUT DOMString *StVar);
extern const char* ContentTypeHeader; extern const char* ContentTypeHeader;
#endif //SOAPLIB_H #endif /* SOAPLIB_H */