dc_DyndeplClient.h File Reference

Dynamic Deployment client API. More...

#include "dc/dc_GenericInvocation.h"

Functions

Get APIs
WS-Transfer "Get" calls.

DC_RT_FMAC1 int dyndepl_get_device (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, parser_cbk response_cbk, void *user_data)
 Get description for a remote device through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_get_device_types (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, parser_cbk response_cbk, void *user_data)
 Get description for a remote device types (WS-Discovery) through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_get_device_scopes (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, parser_cbk response_cbk, void *user_data)
 Get description for a remote device scopes (WS-Discovery) through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_get_this_device (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, parser_cbk response_cbk, void *user_data)
 Get description for a remote device "ThisDevice" metadata (WS-MetadataExchange) through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_get_this_model (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, parser_cbk response_cbk, void *user_data)
 Get description for a remote device "ThisModel" metadata (WS-MetadataExchange) through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_get_service_class (struct dpws *dpws, short href_dyndepl_service_proxy, char *sclass_id, parser_cbk response_cbk, void *user_data)
 Get description for a remote service class through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_get_service (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, char *service_id, parser_cbk response_cbk, void *user_data)
 Get description for a remote service through an invocation of the dynamic deployment service.
Put APIs
WS-Transfer "Put" calls.

DC_RT_FMAC1 int dyndepl_put_device (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Overwrite descriptor for a remote device through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_put_device_types (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Overwrite descriptor for a remote device types through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_put_device_scopes (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Overwrite descriptor for a remote device scopes through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_put_this_device (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Overwrite descriptor for a remote device "ThisDevice" metadata section through an invocation of the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_put_this_model (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Overwrite descriptor for a remote device "ThisModel" metadata section through an invocation of the dynamic deployment service.
Create APIs
WS-Transfer "Create" calls.

DC_RT_FMAC1 int dyndepl_create_device (struct dpws *dpws, short href_dyndepl_service_proxy, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Creates a new remote device using the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_create_service_class (struct dpws *dpws, short href_dyndepl_service_proxy, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Creates a new remote service class using the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_create_service (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, serialize_cbk request_cbk, parser_cbk response_cbk, void *user_data)
 Creates a new remote service using the dynamic deployment service.
Delete APIs
WS-Transfer "Delete" calls.

DC_RT_FMAC1 int dyndepl_delete_device (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid)
 Deletes a remote device using the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_delete_service_class (struct dpws *dpws, short href_dyndepl_service_proxy, char *sclass_id)
 Deletes a remote service class using the dynamic deployment service.
DC_RT_FMAC1 int dyndepl_delete_service (struct dpws *dpws, short href_dyndepl_service_proxy, char *device_uuid, char *service_id)
 Deletes a remote service using the dynamic deployment service.


Detailed Description

Dynamic Deployment client API.

This API is a helper that uses the generic stub feature to invoke the dynamic deployment service without the burden to provide protocol informations like WS-Management headers and operation actions. This also makes clear what subset of the WS-Management is implemented and thus usable.


Function Documentation

DC_RT_FMAC1 int dyndepl_get_device ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
parser_cbk  response_cbk,
void *  user_data 
)

Get description for a remote device through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
response_cbk A generic skeleton callback for response processing, i.e. device descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_get_device_types ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
parser_cbk  response_cbk,
void *  user_data 
)

Get description for a remote device types (WS-Discovery) through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
response_cbk A generic skeleton callback for response processing, i.e. device types descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_get_device_scopes ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
parser_cbk  response_cbk,
void *  user_data 
)

Get description for a remote device scopes (WS-Discovery) through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
response_cbk A generic skeleton callback for response processing, i.e. device scopes descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_get_this_device ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
parser_cbk  response_cbk,
void *  user_data 
)

Get description for a remote device "ThisDevice" metadata (WS-MetadataExchange) through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
response_cbk A generic skeleton callback for response processing, i.e. "ThisDevice" descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_get_this_model ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
parser_cbk  response_cbk,
void *  user_data 
)

Get description for a remote device "ThisModel" metadata (WS-MetadataExchange) through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
response_cbk A generic skeleton callback for response processing, i.e. "ThisModel" descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_get_service_class ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  sclass_id,
parser_cbk  response_cbk,
void *  user_data 
)

Get description for a remote service class through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
sclass_id The service class ID for which information must be retrieved.
response_cbk A generic skeleton callback for response processing, i.e. service class descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_get_service ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
char *  service_id,
parser_cbk  response_cbk,
void *  user_data 
)

Get description for a remote service through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The UUID of the device hosting the target service.
service_id The service ID for which information must be retrieved.
response_cbk A generic skeleton callback for response processing, i.e. service descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_put_device ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Overwrite descriptor for a remote device through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
request_cbk A generic skeleton callback for producing request content, i.e. new device descriptor.
response_cbk A generic skeleton callback for response processing, i.e. updated device descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_put_device_types ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Overwrite descriptor for a remote device types through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
request_cbk A generic skeleton callback for producing request content, i.e. new device types descriptor.
response_cbk A generic skeleton callback for response processing, i.e. updated device types descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_put_device_scopes ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Overwrite descriptor for a remote device scopes through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
request_cbk A generic skeleton callback for producing request content, i.e. new device scopes descriptor.
response_cbk A generic skeleton callback for response processing, i.e. updated device scopes descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_put_this_device ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Overwrite descriptor for a remote device "ThisDevice" metadata section through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
request_cbk A generic skeleton callback for producing request content, i.e. new "ThisDevice" descriptor.
response_cbk A generic skeleton callback for response processing, i.e. updated "ThisDevice" descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_put_this_model ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Overwrite descriptor for a remote device "ThisModel" metadata section through an invocation of the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The device UUID for which information must be retrieved.
request_cbk A generic skeleton callback for producing request content, i.e. new "ThisModel" descriptor.
response_cbk A generic skeleton callback for response processing, i.e. updated "ThisModel" descriptor.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_create_device ( struct dpws dpws,
short  href_dyndepl_service_proxy,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Creates a new remote device using the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
request_cbk A generic skeleton callback for producing request content, i.e. new device descriptor.
response_cbk A generic skeleton callback for response processing, i.e. created resource information.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_create_service_class ( struct dpws dpws,
short  href_dyndepl_service_proxy,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Creates a new remote service class using the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
request_cbk A generic skeleton callback for producing request content, i.e. new service class descriptor.
response_cbk A generic skeleton callback for response processing, i.e. created resource information.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_create_service ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
serialize_cbk  request_cbk,
parser_cbk  response_cbk,
void *  user_data 
)

Creates a new remote service using the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The UUID of the device that will host the new service.
request_cbk A generic skeleton callback for producing request content, i.e. new service descriptor.
response_cbk A generic skeleton callback for response processing, i.e. created resource information.
user_data Data that will be passed to message callback.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_delete_device ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid 
)

Deletes a remote device using the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The UUID of the device to delete.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_delete_service_class ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  sclass_id 
)

Deletes a remote service class using the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
sclass_id The ID of the service class to delete.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.

DC_RT_FMAC1 int dyndepl_delete_service ( struct dpws dpws,
short  href_dyndepl_service_proxy,
char *  device_uuid,
char *  service_id 
)

Deletes a remote service using the dynamic deployment service.

Parameters:
dpws A pointer on a dpws data structure used to process the request.
href_dyndepl_service_proxy The handle reference of the dynamic deployment service proxy.
device_uuid The UUID of the device that hosts the service.
service_id The ID of the service to delete.
Returns:
DPWS_OK, if no communication error occurred. Indeed, the user has to check that the received response is not a fault. A DPWS or gSOAP error code otherwise.


Generated on Fri Apr 17 15:18:25 2009 for DPWSCore by  doxygen 1.5.8