cproperty.h File Reference

#include <cybergarage/typedef.h>
#include <cybergarage/util/clist.h>
#include <cybergarage/util/cstring.h>
#include <cybergarage/net/curl.h>
#include <cybergarage/upnp/cstatevariable.h>

Data Structures
struct	_CgUpnpProperty
Defines
#define	cg_upnp_property_next(prop)   (CgUpnpProperty *)cg_list_next((CgList *)prop)
#define	cg_upnp_property_setname(prop, value)   cg_string_setvalue(prop->name, value)
#define	cg_upnp_property_getname(prop)   cg_string_getvalue(prop->name)
#define	cg_upnp_property_setvalue(prop, nvalue)   cg_string_setvalue(prop->value, nvalue)
#define	cg_upnp_property_getvalue(prop)   cg_string_getvalue(prop->value)
#define	cg_upnp_property_setsid(prop, value)   cg_string_setvalue(prop->sid, value)
#define	cg_upnp_property_getsid(prop)   cg_string_getvalue(prop->sid)
#define	cg_upnp_property_setseq(prop, value)   (prop->seq = value)
#define	cg_upnp_property_getseq(prop)   (prop->seq)
#define	cg_upnp_propertylist_clear(propList)   cg_list_clear((CgList *)propList, (CG_LIST_DESTRUCTORFUNC)cg_upnp_property_delete)
#define	cg_upnp_propertylist_size(propList)   cg_list_size((CgList *)propList)
#define	cg_upnp_propertylist_gets(propList)   (CgUpnpProperty *)cg_list_next((CgList *)propList)
#define	cg_upnp_propertylist_add(propList, prop)   cg_list_add((CgList *)propList, (CgList *)prop)
Typedefs
typedef _CgUpnpProperty	CgUpnpProperty
typedef _CgUpnpProperty	CgUpnpPropertyList
Functions
CgUpnpProperty *	cg_upnp_property_new ()
void	cg_upnp_property_delete (CgUpnpProperty *prop)
void	cg_upnp_property_clear (CgUpnpProperty *prop)
CgUpnpPropertyList *	cg_upnp_propertylist_new ()
void	cg_upnp_propertylist_delete (CgUpnpPropertyList *propertylist)

---

Define Documentation

#define cg_upnp_property_getname

(

prop

)

cg_string_getvalue(prop->name)

Get property name

Parameters:

prop

UPnP property

#define cg_upnp_property_getseq

(

prop

)

(prop->seq)

Get sequence number from UPnP property

Parameters:

prop

UPnP property

#define cg_upnp_property_getsid

(

prop

)

cg_string_getvalue(prop->sid)

Get SID from UPnP property

Parameters:

prop

UPnP property

#define cg_upnp_property_getvalue

(

prop

)

cg_string_getvalue(prop->value)

Get value from property

Parameters:

prop

UPnP property

#define cg_upnp_property_next

(

prop

)

(CgUpnpProperty *)cg_list_next((CgList *)prop)

Fetches next UPnP property from property list

Parameters:

prop

UPnP property

#define cg_upnp_property_setname	(	prop,
		value		)	cg_string_setvalue(prop->name, value)

Set property name

Parameters:

	prop	UPnP property
	value	Name

#define cg_upnp_property_setseq	(	prop,
		value		)	(prop->seq = value)

Set sequence number for UPnP property

Parameters:

	prop	UPnP property
	value

#define cg_upnp_property_setsid	(	prop,
		value		)	cg_string_setvalue(prop->sid, value)

Set SID for UPnP property

Parameters:

	prop	UPnP property
	value	Value

#define cg_upnp_property_setvalue	(	prop,
		nvalue		)	cg_string_setvalue(prop->value, nvalue)

Set value for UPnP property

Parameters:

	prop	UPnP property
	nvalue	Value

#define cg_upnp_propertylist_add	(	propList,
		prop		)	cg_list_add((CgList *)propList, (CgList *)prop)

Add new property into property list

Parameters:

	propList	UPnP property list
	prop	UPnP property

#define cg_upnp_propertylist_clear

(

propList

)

cg_list_clear((CgList *)propList, (CG_LIST_DESTRUCTORFUNC)cg_upnp_property_delete)

Clear UPnP propertylist

Parameters:

propList

UPnP property list

#define cg_upnp_propertylist_gets

(

propList

)

(CgUpnpProperty *)cg_list_next((CgList *)propList)

Get next list element from property list

Parameters:

propList

UPnP property list

#define cg_upnp_propertylist_size

(

propList

)

cg_list_size((CgList *)propList)

Get size of property list

Parameters:

propList

UPnP property list

---

Typedef Documentation

typedef struct _CgUpnpProperty CgUpnpProperty

Type definition for UPnP property

typedef struct _CgUpnpProperty CgUpnpPropertyList

Type definition for UPnP property

---

Function Documentation

void cg_upnp_property_clear

(

CgUpnpProperty *

prop

)

Clear UPnP property

Parameters:

prop

UPnP property

void cg_upnp_property_delete

(

CgUpnpProperty *

prop

)

Delete UPnP property object

Parameters:

prop

UPnP property

CgUpnpProperty* cg_upnp_property_new

(

)

Construct new UPnP property object

void cg_upnp_propertylist_delete

(

CgUpnpPropertyList *

propertylist

)

Delete UPnP property list

Parameters:

propertylist

UPnP property list

CgUpnpPropertyList* cg_upnp_propertylist_new

(

)

Create new UPnP property list

---