nntpgrab_plugin_par2.h File Reference

#include "nntpgrab_plugin_base.h"
#include "collections.h"

Go to the source code of this file.

Data Structures
struct	_plugin_par2_imported_funcs
Typedefs
typedef G_BEGIN_DECLS struct _plugin_par2_imported_funcs	PluginPar2ImportedFuncs
Functions
gboolean	nntpgrab_plugin_par2_initialize (PluginPar2ImportedFuncs funcs, char **errmsg)
	Initialize the plugin.
void	nntpgrab_plugin_par2_destroy (void)
	Destroy the plugin.
int	nntpgrab_plugin_par2_get_version (void)
	Return the API version of the plugin.
gboolean	nntpgrab_plugin_par2_load_verification_packet (const char *filename, PAR2Set **par2set)
	Try to read any PAR2 verification data from the given file.
gboolean	nntpgrab_plugin_par2_repair_files (const char *directory, const char *par2filename)
	Repair the files using PAR2.

---

Typedef Documentation

typedef G_BEGIN_DECLS struct _plugin_par2_imported_funcs PluginPar2ImportedFuncs

---

Function Documentation

void nntpgrab_plugin_par2_destroy

(

void

)

Destroy the plugin.

int nntpgrab_plugin_par2_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_API_VERSION

gboolean nntpgrab_plugin_par2_initialize	(	PluginPar2ImportedFuncs	funcs,
		char **	errmsg
	)

Initialize the plugin.

• funcs A structure containing all the callback functions the plugin can call to notify the NNTPGrab Core
• errmsg Pointer to a g_malloc'ed error message which will be set when the function returns FALSE

Returns:

TRUE when the initialization was successfull

gboolean nntpgrab_plugin_par2_load_verification_packet	(	const char *	filename,
		PAR2Set **	par2set
	)

Try to read any PAR2 verification data from the given file.

• filename The filename which should contain PAR2 verification data
• par2set A pointer in which the newly allocated par2set can be set

Returns:

TRUE when PAR2 recovery data has been successfully read

gboolean nntpgrab_plugin_par2_repair_files	(	const char *	directory,
		const char *	par2filename
	)

Repair the files using PAR2.

• directory The directory where all the files are situated
• par2filename The filename of (one of the) .par2 file(s)

Returns:

TRUE on success

---