nntpgrab.h

Go to the documentation of this file.

/*
 Copyright (C) 2005-2009 Erik van Pienbroek

 This program 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 2 of the License, or
 (at your option) any later version.

 This program 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 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/

#ifndef _NNTPGRAB_H_
#define _NNTPGRAB_H_

#include "nntpgrab_types.h"

#ifdef __cplusplus
extern "C" {
#endif

#define NNTPGRAB_API_VERSION 20090505

typedef struct NNTPGrabCore NNTPGrabCore;
typedef struct NNTPGrabCoreClass NNTPGrabCoreClass;

NNTPGrabCore   *nntpgrab_core_init(int version, char **err, char **warnings);

void            nntpgrab_core_cleanup(NNTPGrabCore *obj);

NGList         *nntpgrab_core_config_get_avail_servers(NNTPGrabCore *obj);

void            nntpgrab_core_config_free_avail_servers(NNTPGrabCore *obj, NGList *servers);

ngboolean       nntpgrab_core_config_get_server_info(NNTPGrabCore *obj, const char *servername, ConfigServer *server);

ngboolean       nntpgrab_core_config_add_server(NNTPGrabCore *obj, ConfigServer new_server, char **errmsg);

ngboolean       nntpgrab_core_config_del_server(NNTPGrabCore *obj, const char *servername, char **errmsg);

ngboolean       nntpgrab_core_config_edit_server(NNTPGrabCore *obj, const char *servername, ConfigServer server, char **errmsg);

ConfigOpts      nntpgrab_core_config_get_opts(NNTPGrabCore *obj);

void            nntpgrab_core_config_set_opts(NNTPGrabCore *obj, ConfigOpts opts);

ngboolean       nntpgrab_core_config_get_folder_listing(NNTPGrabCore *obj, const char *parent, NGList **folders);

void            nntpgrab_core_config_free_folder_listing(NNTPGrabCore *obj, NGList *folders);

ngboolean       nntpgrab_core_schedular_start(NNTPGrabCore *obj);

ngboolean       nntpgrab_core_schedular_stop(NNTPGrabCore *obj, ngboolean wait);

SchedularState  nntpgrab_core_schedular_get_state(NNTPGrabCore *obj);

ngboolean       nntpgrab_core_schedular_add_task_to_queue(NNTPGrabCore *obj, const char *collection_name, const char *subject, const char *poster, time_t stamp, nguint64 file_size, NGList *groups, NGList *parts, char **errmsg);

ngboolean       nntpgrab_core_schedular_del_task_from_queue(NNTPGrabCore *obj, const char *collection_name, const char *subject, char **errmsg);

ngboolean       nntpgrab_core_schedular_restart_task(NNTPGrabCore *obj, const char *collection_name, const char *subject, char **errmsg);

ngboolean       nntpgrab_core_schedular_save_queue(NNTPGrabCore *obj, char **errmsg);

void            nntpgrab_core_schedular_foreach_task(NNTPGrabCore *obj, ForeachCollectionFunc collection_func, ForeachFileFunc file_func, ForeachGroupFunc group_func, void *data);

ngboolean       nntpgrab_core_schedular_move_task(NNTPGrabCore *obj, const char *collection_name_src, const char *subject_src, const char *collection_name_dest, int position_dest);

ngboolean       nntpgrab_core_schedular_move_collection(NNTPGrabCore *obj, const char *collection_name, int new_position);

#ifdef __cplusplus
}
#endif

#endif /* _NNTPGRAB_H_ */

---