nntpgrab_plugin_nntp.h File Reference

#include "nntpgrab_plugin_base.h"

Go to the source code of this file.

Data Structures
struct	_plugin_nntp_imported_funcs
Typedefs
typedef struct _plugin_nntp_imported_funcs	PluginNNTPImportedFuncs
Functions
gboolean	nntpgrab_plugin_nntp_initialize (PluginNNTPImportedFuncs funcs)
	Initialize the plugin.
int	nntpgrab_plugin_nntp_get_version (void)
	Return the API version of the plugin.
gboolean	nntpgrab_plugin_nntp_get_is_connected (int conn_id)
	Function to check is the connection is still alive.
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)
	Connect to the specified usenet server with the given parameters.
void	nntpgrab_plugin_nntp_disconnect (int conn_id, gpointer data)
	Disconnect from the connected server.
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)
	Get a article from the connected usenet server.
NNTPGrabErrCode	nntpgrab_plugin_nntp_group (int conn_id, const char *newsgroup, int *num_articles, gint64 *start_article, gint64 *end_article, gpointer data)
	Set the active newsgroup.
NNTPGrabErrCode	nntpgrab_plugin_nntp_xover (int conn_id, gint64 start_range, gint64 end_range, gpointer data)
	Retrieve a list of the available messages in active newsgroup.

---

Typedef Documentation

typedef struct _plugin_nntp_imported_funcs PluginNNTPImportedFuncs

---

Function Documentation

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
	)

Connect to the specified usenet server with the given parameters.

• hostname The hostname (or IP address) of the usenet server to connect to
• port The port to connect to
• username A username which is required to login, can be NULL
• password A password which is required to login, can be NULL
• use_ssl Do we need to use NNTP over SSL?
• errmsg If an error occurs, a message can be saved here, can be NULL
• conn_id Pointer to a integer where the connection ID will be saved
• data Data to be used by callback functions

Returns:

ERROR_NONE when the connection and login are successfull

void nntpgrab_plugin_nntp_disconnect	(	int	conn_id,
		gpointer	data
	)

Disconnect from the connected server.

• conn_id The connection ID
• data Data to be used by callback functions

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
	)

Get a article from the connected usenet server.

• conn_id The connection ID
• message_id The message-id of the article requested
• headers Pointer to catch all the headers, can be NULL
• filename The filename of the file where the message data needs to be saved
• cb_data Data to be used by callback functions

Returns:

ERROR_NONE on success

gboolean nntpgrab_plugin_nntp_get_is_connected

(

int

conn_id

)

Function to check is the connection is still alive.

• conn_id The connection ID to check

Returns:

TRUE when the connection is still alive

int nntpgrab_plugin_nntp_get_version

(

void

)

Return the API version of the plugin.

This is used to verify that the plugin is compatible with the interface the NNTPGrab Core expects

Returns:

NNTPGRAB_PLUGIN_NNTP_API_VERSION

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

Set the active newsgroup.

• conn_id The connection ID
• newsgroup The name of the newsgroup which need to be selected
• num_articles Pointer to set the number of articles present in the given group
• start_article Pointer to set the first article number of the given group
• end_article Pointer to set the last article number of the given group
• data Data to be used by callback functions

gboolean nntpgrab_plugin_nntp_initialize

(

PluginNNTPImportedFuncs

funcs

)

Initialize the plugin.

• funcs A structure containing all the callback functions the plugin can call to notify the NNTPGrab Core

Returns:

TRUE when the initialization was successfull

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

Retrieve a list of the available messages in active newsgroup.

• conn_id The connection ID
• start_range The beginning of the range.
• end_range The end of the range. If -1, then all available messages are checked
• data Data to be used by callback functions

---