nntpgrab_plugin_nntp.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_PLUGIN_NNTP_H_
#define _NNTPGRAB_PLUGIN_NNTP_H_

#include "nntpgrab_plugin_base.h"

// These are all the functions that the plugin can call to communicate with the NNTPGrab core
typedef struct _plugin_nntp_imported_funcs {
    int version;

    void (*update_progress) (int bytes_downloaded, gpointer data);
    void (*update_traffic_monitor) (int bytes_received[10], time_t stamp);
    void (*notify_download_begin) (gpointer data);
    void (*notify_connecting) (int conn_id, gpointer data);
    void (*notify_connected) (const char *welcome_msg, gpointer data);
    void (*notify_disconnect) (NNTPDisconnectType disconnect_type, const char *errmsg, gpointer data);
    void (*parse_header) (int position, const char *subject, const char *poster, time_t postdate, const char *message_id, int size, int numlines, int start_range, int end_range, gpointer data);
} PluginNNTPImportedFuncs;

// The plugin needs to exported these methods :

gboolean     nntpgrab_plugin_nntp_initialize(PluginNNTPImportedFuncs funcs);

int          nntpgrab_plugin_nntp_get_version(void);

gboolean     nntpgrab_plugin_nntp_get_is_connected(int conn_id);

NNTPGrabErrCode  nntpgrab_plugin_nntp_connect(const char *hostname, int port, const char *username, const char *password, gboolean use_ssl, char **errmsg, int *conn_id, gpointer data);

void             nntpgrab_plugin_nntp_disconnect(int conn_id, gpointer data);

NNTPGrabErrCode  nntpgrab_plugin_nntp_get_article_by_message_id(int conn_id, const char *message_id, const char **headers, const char *filename, gpointer cb_data);

NNTPGrabErrCode  nntpgrab_plugin_nntp_group(int conn_id, const char *newsgroup, int *num_articles, gint64 *start_article, gint64 *end_article, gpointer data);

NNTPGrabErrCode  nntpgrab_plugin_nntp_xover(int conn_id, gint64 start_range, gint64 end_range, gpointer data);

#endif /* _NNTPGRAB_PLUGIN_NNTP_H_ */

---