mUPnP for C
Data Structures | Macros | Typedefs | Functions
property.h File Reference
#include <mupnp/typedef.h>
#include <mupnp/net/url.h>
#include <mupnp/util/list.h>
#include <mupnp/util/string.h>
#include <mupnp/statevariable.h>

Data Structures

struct  _mUpnpProperty
 

Macros

#define mupnp_property_next(prop)
 
#define mupnp_property_setname(prop, value)
 
#define mupnp_property_getname(prop)
 
#define mupnp_property_setvalue(prop, nvalue)
 
#define mupnp_property_getvalue(prop)
 
#define mupnp_property_setsid(prop, value)
 
#define mupnp_property_getsid(prop)
 
#define mupnp_property_setseq(prop, value)
 
#define mupnp_property_getseq(prop)
 
#define mupnp_propertylist_clear(propList)
 
#define mupnp_propertylist_size(propList)
 
#define mupnp_propertylist_gets(propList)
 
#define mupnp_propertylist_add(propList, prop)
 

Typedefs

typedef struct _mUpnpProperty mUpnpProperty
 
typedef struct _mUpnpProperty mUpnpPropertyList
 

Functions

mUpnpProperty * mupnp_property_new (void)
 
void mupnp_property_delete (mUpnpProperty *prop)
 
void mupnp_property_clear (mUpnpProperty *prop)
 
mUpnpPropertyList * mupnp_propertylist_new (void)
 
void mupnp_propertylist_delete (mUpnpPropertyList *propertylist)
 

Macro Definition Documentation

◆ mupnp_property_getname

#define mupnp_property_getname ( prop)
Value:
mupnp_string_getvalue(prop->name)
mupnp_string_getvalue
char * mupnp_string_getvalue(mUpnpString *str)
Definition string.c:177

Get property name

Parameters
propUPnP property

◆ mupnp_property_getseq

#define mupnp_property_getseq ( prop)
Value:
(prop->seq)

Get sequence number from UPnP property

Parameters
propUPnP property

◆ mupnp_property_getsid

#define mupnp_property_getsid ( prop)
Value:
mupnp_string_getvalue(prop->sid)

Get SID from UPnP property

Parameters
propUPnP property

◆ mupnp_property_getvalue

#define mupnp_property_getvalue ( prop)
Value:
mupnp_string_getvalue(prop->value)

Get value from property

Parameters
propUPnP property

◆ mupnp_property_next

#define mupnp_property_next ( prop)
Value:
(mUpnpProperty*)mupnp_list_next((mUpnpList*)prop)
mupnp_list_next
mUpnpList * mupnp_list_next(mUpnpList *list)
Definition list.c:234
_mUpnpList
The generic list interface in mUPnP.
Definition list.h:56
_mUpnpProperty
Definition property.h:30

Fetches next UPnP property from property list

Parameters
propUPnP property

◆ mupnp_property_setname

#define mupnp_property_setname ( prop,
value )
Value:
mupnp_string_setvalue(prop->name, value)
mupnp_string_setvalue
void mupnp_string_setvalue(mUpnpString *str, const char *value)
Definition string.c:84

Set property name

Parameters
propUPnP property
valueName

◆ mupnp_property_setseq

#define mupnp_property_setseq ( prop,
value )
Value:
(prop->seq = value)

Set sequence number for UPnP property

Parameters
propUPnP property
value

◆ mupnp_property_setsid

#define mupnp_property_setsid ( prop,
value )
Value:
mupnp_string_setvalue(prop->sid, value)

Set SID for UPnP property

Parameters
propUPnP property
valueValue

◆ mupnp_property_setvalue

#define mupnp_property_setvalue ( prop,
nvalue )
Value:
mupnp_string_setvalue(prop->value, nvalue)

Set value for UPnP property

Parameters
propUPnP property
nvalueValue

◆ mupnp_propertylist_add

#define mupnp_propertylist_add ( propList,
prop )
Value:
mupnp_list_add((mUpnpList*)propList, (mUpnpList*)prop)
mupnp_list_add
void mupnp_list_add(mUpnpList *headList, mUpnpList *list)
Add a node to the end of a list.
Definition list.c:123

Add new property into property list

Parameters
propListUPnP property list
propUPnP property

◆ mupnp_propertylist_clear

#define mupnp_propertylist_clear ( propList)
Value:
mupnp_list_clear((mUpnpList*)propList, (MUPNP_LIST_DESTRUCTORFUNC)mupnp_property_delete)
mupnp_list_clear
void mupnp_list_clear(mUpnpList *headList, MUPNP_LIST_DESTRUCTORFUNC destructorFunc)
Definition list.c:257
MUPNP_LIST_DESTRUCTORFUNC
void(* MUPNP_LIST_DESTRUCTORFUNC)(void *)
Definition list.h:29
mupnp_property_delete
void mupnp_property_delete(mUpnpProperty *prop)
Definition property.c:56

Clear UPnP propertylist

Parameters
propListUPnP property list

◆ mupnp_propertylist_gets

#define mupnp_propertylist_gets ( propList)
Value:
(mUpnpProperty*)mupnp_list_next((mUpnpList*)propList)

Get next list element from property list

Parameters
propListUPnP property list

◆ mupnp_propertylist_size

#define mupnp_propertylist_size ( propList)
Value:
mupnp_list_size((mUpnpList*)propList)
mupnp_list_size
int mupnp_list_size(mUpnpList *headList)
Definition list.c:53

Get size of property list

Parameters
propListUPnP property list

Typedef Documentation

◆ mUpnpProperty

typedef struct _mUpnpProperty mUpnpProperty

Type definition for UPnP property

◆ mUpnpPropertyList

typedef struct _mUpnpProperty mUpnpPropertyList

Function Documentation

◆ mupnp_property_clear()

void mupnp_property_clear ( mUpnpProperty * prop)

Clear UPnP property

Parameters
propUPnP property

◆ mupnp_property_delete()

void mupnp_property_delete ( mUpnpProperty * prop)

Delete UPnP property object

Parameters
propUPnP property

◆ mupnp_property_new()

mUpnpProperty * mupnp_property_new ( void )

Construct new UPnP property object

◆ mupnp_propertylist_delete()

void mupnp_propertylist_delete ( mUpnpPropertyList * propertylist)

Delete UPnP property list

Parameters
propertylistUPnP property list

◆ mupnp_propertylist_new()

mUpnpPropertyList * mupnp_propertylist_new ( void )

Create new UPnP property list