doubango/trunk/tinyXCAP/src/txc_oma-directory.h

76 lines
2.7 KiB
C

/*
* Copyright (C) 2009 Mamadou Diop.
*
* Contact: Mamadou Diop <diopmamadou@yahoo.fr>
*
* This file is part of Open Source Doubango Framework.
*
* DOUBANGO is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* DOUBANGO is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with DOUBANGO.
*
*/
/**@file txc_oma-directory.h
* @brief <a href="http://www.openmobilealliance.org/Technical/release_program/docs/XDM/V1_1-20080627-A/OMA-TS-XDM_Core-V1_1-20080627-A.pdf">[OMA-TS-XDM_Core-V1_1-20080627-A] - OMA XCAP directory subclause 6.7.2</a>
*
* @author Mamadou Diop <diopmamadou(at)yahoo.fr>
*
* @date Created: Sat Nov 8 16:54:58 2009 mdiop
*/
#ifndef _TINYXCAP_TXC_OMA_DIRECTORY_H_
#define _TINYXCAP_TXC_OMA_DIRECTORY_H_
#include "tinyxcap_config.h"
#include "txc.h"
#include "txc_rlist.h"
/**@def TXC_OMADIR_FOLDER_CREATE
* Create an OMA XCAP directory folder
* You MUST @ref TXC_OMADIR_FOLDER_SAFE_FREE to free the objet.
* @sa @ref TXC_OMADIR_FOLDER_SAFE_FREE
*/
/**@def TXC_OMADIR_FOLDER_SAFE_FREE
* Safely free an OMA XCAP directory previously created using @ref TXC_OMADIR_FOLDER_CREATE.
* @sa @ref TXC_OMADIR_FOLDER_CREATE
*/
#define TXC_OMADIR_FOLDER_CREATE(folder) TXC_XXX_CREATE2(folder, omadir_folder)
#define TXC_OMADIR_FOLDER_SAFE_FREE(folder) TXC_XXX_SAFE_FREE2(folder, omadir_folder)
/** OMA XCAP directory folder .
*/
typedef struct txc_omadir_folder_s
{
char* auid; /**< The auid of the folder */
}
txc_omadir_folder_t;
typedef tsk_list_t txc_omadir_folder_L_t; /* List of @ref txc_omadir_folder_t elements */
/**OMA XCAP directory context. */
typedef struct txc_omadir_s
{
xmlDocPtr docPtr; /**< Pointer to the XML document*/
}
txc_omadir_t;
void txc_omadir_folder_init(txc_omadir_folder_t *folder);
void txc_omadir_folder_free(void **folder);
txc_omadir_folder_t* txc_omadir_folder_from_xml(xmlNodePtr node);
TINYXCAP_API txc_omadir_t* txc_omadir_create(const char* buffer, size_t size);
TINYXCAP_API txc_omadir_folder_L_t* txc_omadir_get_all_folders(const txc_omadir_t* omadir);
TINYXCAP_API txc_rlist_entry_L_t* txc_omadir_get_entries_by_folder(const txc_omadir_t* omadir, const char* fo_auid);
TINYXCAP_API void txc_omadir_free(txc_omadir_t **omadir);
#endif /* _TINYXCAP_TXC_OMA_DIRECTORY_H_ */