![]() |
![]() |
![]() |
NNTPGrab Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
#define NNTPGRAB_GLUE_VERSION typedef NNTPGrabGlue; typedef NNTPGrabGlueClass; NNTPGrabGlue * nntpgrab_glue_new (void
); void nntpgrab_glue_destroy (NNTPGrabGlue *obj
); ngboolean nntpgrab_glue_connect (NNTPGrabGlue *obj
,const char *hostname
,int port
,const char *username
,const char *password
,ngboolean use_ssl
,char **err
,char **warnings
); ngboolean nntpgrab_glue_get_is_connected (NNTPGrabGlue *obj
); ngboolean nntpgrab_glue_get_is_standalone (NNTPGrabGlue *obj
); NGList * nntpgrab_config_get_avail_servers (NNTPGrabGlue *obj
); void nntpgrab_config_free_avail_servers (NNTPGrabGlue *obj
,NGList *servers
); ngboolean nntpgrab_config_get_server_info (NNTPGrabGlue *obj
,const char *servername
,ConfigServer *server
); ngboolean nntpgrab_config_add_server (NNTPGrabGlue *obj
,ConfigServer new_server
,char **errmsg
); ngboolean nntpgrab_config_del_server (NNTPGrabGlue *obj
,const char *servername
,char **errmsg
); ngboolean nntpgrab_config_edit_server (NNTPGrabGlue *obj
,const char *servername
,ConfigServer server
,char **errmsg
); ConfigOpts nntpgrab_config_get_opts (NNTPGrabGlue *obj
); void nntpgrab_config_set_opts (NNTPGrabGlue *obj
,ConfigOpts opts
); ngboolean nntpgrab_config_get_folder_listing (NNTPGrabGlue *obj
,const char *parent
,NGList **folders
); void nntpgrab_config_free_folder_listing (NNTPGrabGlue *obj
,NGList *folders
); ngboolean nntpgrab_schedular_start (NNTPGrabGlue *obj
); ngboolean nntpgrab_schedular_stop (NNTPGrabGlue *obj
,ngboolean wait
); NGSchedularState nntpgrab_schedular_get_state (NNTPGrabGlue *obj
); ngboolean nntpgrab_schedular_add_task_to_queue (NNTPGrabGlue *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_schedular_del_task_from_queue (NNTPGrabGlue *obj
,const char *collection_name
,const char *subject
,char **errmsg
); ngboolean nntpgrab_schedular_restart_task (NNTPGrabGlue *obj
,const char *collection_name
,const char *subject
,char **errmsg
); ngboolean nntpgrab_schedular_save_queue (NNTPGrabGlue *obj
,char **errmsg
); void nntpgrab_schedular_foreach_task (NNTPGrabGlue *obj
,ForeachCollectionFunc collection_func
,ForeachFileFunc file_func
,ForeachGroupFunc group_func
,void *data
); ngboolean nntpgrab_schedular_move_task (NNTPGrabGlue *obj
,const char *collection_name_src
,const char *subject_src
,const char *collection_name_dest
,int position_dest
); ngboolean nntpgrab_schedular_move_collection (NNTPGrabGlue *obj
,const char *collection_name
,int new_position
); ngboolean nntpgrab_schedular_mark_task_optional (NNTPGrabGlue *obj
,const char *collection_name
,const char *subject
,ngboolean is_optional
); NGList * nntpgrab_plugins_get_avail_plugins (NNTPGrabGlue *obj
); void nntpgrab_plugins_free_avail_plugins (NNTPGrabGlue *obj
,NGList *plugins
); ngboolean nntpgrab_plugins_get_plugin_info (NNTPGrabGlue *obj
,const char *plugin_name
,NNTPGrabPluginInfo *plugin_info
); ngboolean nntpgrab_plugins_load_plugin (NNTPGrabGlue *obj
,const char *plugin_name
,char **errmsg
); ngboolean nntpgrab_plugins_unload_plugin (NNTPGrabGlue *obj
,const char *plugin_name
,char **errmsg
); ngboolean nntpgrab_plugins_set_persistent (NNTPGrabGlue *obj
,const char *plugin_name
,ngboolean persistent
);
"all-downloads-completed" : Run Last / Has Details "collection-added" : Run Last / Has Details "collection-downloaded" : Run Last / Has Details "collection-modified" : Run Last / Has Details "collection-moved" : Run Last / Has Details "collection-removed" : Run Last / Has Details "config-changed" : Run Last / Has Details "connection-connected" : Run Last / Has Details "connection-connecting" : Run Last / Has Details "connection-disconnect" : Run Last / Has Details "connection-lost" : Run Last / Has Details "file-added" : Run Last / Has Details "file-download-state-update" : Run Last / Has Details "file-removed" : Run Last / Has Details "file-state-changed" : Run Last / Has Details "log-message" : Run Last / Has Details "part-done" : Run Last / Has Details "part-download-start" : Run Last / Has Details "part-failed" : Run Last / Has Details "part-progress-update" : Run Last / Has Details "plugin-event" : Run Last / Has Details "plugin-loaded" : Run Last / Has Details "plugin-unloaded" : Run Last / Has Details "schedular-state-changed" : Run Last / Has Details "task-moved" : Run Last / Has Details "traffic-monitor-update" : Run Last / Has Details
NNTPGrabGlue * nntpgrab_glue_new (void
);
Creates a new instance of the NNTPGrabGlue object. This is required for all other NNTPGrab functions
Returns : |
An instance of the NNTPGrabGlue which need to be used for other NNTPGrab functions |
void nntpgrab_glue_destroy (NNTPGrabGlue *obj
);
Cleanup the NNTPGrab Glue library. After this function is called, the NNTPGrabGlue instance can't be used anymore
|
An instance of the NNTPGrabGlue |
ngboolean nntpgrab_glue_connect (NNTPGrabGlue *obj
,const char *hostname
,int port
,const char *username
,const char *password
,ngboolean use_ssl
,char **err
,char **warnings
);
Connect to an already running NNTPGrab Server OR start the standalone version of NNTPGrab Note that even if this function returns TRUE, the warnings argument MAY be set
|
An instance of the NNTPGrabGlue |
|
The hostname where the NNTPGrab Server is running. If this is NULL, the standalone version of NNTPGrab will be started. In that case, the contents of the fields port, username, password and use_ssl are ignored. allow-none. |
|
The port where the NNTPGrab Server is running |
|
The username of an user who is allowed to connect to the NNTPGrab Server. This feature isn't implemented yet, so keep it NULL for now. allow-none. |
|
The password of an user who is allowed to connect to the NNTPGrab Server. This feature isn't implemented yet, so keep it NULL for now. allow-none. |
|
Do we want to have an encrypted connection to the NNTPGrab Server. This feature isn't implemented yet, so keep it FALSE for now |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
|
Pointer to a char*. If an (non-fatal) warning occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE on success, FALSE on failure |
ngboolean nntpgrab_glue_get_is_connected (NNTPGrabGlue *obj
);
Find out is we are already connected to an NNTPGrab Server
|
An instance of the NNTPGrabGlue |
Returns : |
TRUE if we are already connected, FALSE if not |
ngboolean nntpgrab_glue_get_is_standalone (NNTPGrabGlue *obj
);
Find out if we are running the standalone version of NNTPGrab
|
An instance of the NNTPGrabGlue |
Returns : |
TRUE if we are running the standalone version of NNTPGrab, FALSE if not |
NGList * nntpgrab_config_get_avail_servers (NNTPGrabGlue *obj
);
Retrieve a list of the available usenet servers
|
An instance of the NNTPGrabGlue |
Returns : |
A list of all the available usenet servers. Needs to be freed using nntpgrab_config_free_avail_servers()
|
void nntpgrab_config_free_avail_servers (NNTPGrabGlue *obj
,NGList *servers
);
ngboolean nntpgrab_config_get_server_info (NNTPGrabGlue *obj
,const char *servername
,ConfigServer *server
);
Get the configuration details about a specific usenet server
|
An instance of the NNTPGrabGlue |
|
The name of the server whose details should be retrieved |
|
The address of a ConfigServer structure which will be used to fill in the configuration details. out. |
Returns : |
TRUE on success (server will be filled in), FALSE if the server isn't known |
ngboolean nntpgrab_config_add_server (NNTPGrabGlue *obj
,ConfigServer new_server
,char **errmsg
);
Add a new usenet server to the NNTPGrab configuration
|
An instance of the NNTPGrabGlue |
|
A structure containing the details about the new usenet server |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE when the server was successfully added. FALSE on failure (the reason will be placed in the errmsg field) |
ngboolean nntpgrab_config_del_server (NNTPGrabGlue *obj
,const char *servername
,char **errmsg
);
Remove a usenet server from the NNTPGrab configuration
|
An instance of the NNTPGrabGlue |
|
The name of the server whose entry should be removed |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE when the server was successfully removed. FALSE on failure (the reason will be placed in the errmsg field) |
ngboolean nntpgrab_config_edit_server (NNTPGrabGlue *obj
,const char *servername
,ConfigServer server
,char **errmsg
);
Adjust the configuration details of an usenet server
|
An instance of the NNTPGrabGlue |
|
The name of the server whose entry should be adjusted |
|
A structure containing the new configuration details of the given servername |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE when the server was successfully adjusted. FALSE on failure (the reason will be placed in the errmsg field) |
ConfigOpts nntpgrab_config_get_opts (NNTPGrabGlue *obj
);
Retrieve the general configuration options
|
An instance of the NNTPGrabGlue |
Returns : |
A structure containing the general configuration options |
void nntpgrab_config_set_opts (NNTPGrabGlue *obj
,ConfigOpts opts
);
Adjust the general configuration options
|
An instance of the NNTPGrabCore |
|
A structure containing the new general configuration options |
ngboolean nntpgrab_config_get_folder_listing (NNTPGrabGlue *obj
,const char *parent
,NGList **folders
);
Retrieves a list containing all the sub-folders which are in the given folder
|
An instance of the NNTPGrabGlue |
|
The name of the directory whose sub-folders should be retrieved. When this is NULL all available drives will be returned (when the host is running Windows). allow-none. |
|
Pointer to a NGList*. The list of sub-folders will be placed in this field. This list needs to be free'd using the function nntpgrab_config_free_folder_listing() . element-type NNTPGrabFolder. out NNTPGrabFolder. |
Returns : |
TRUE on sucess, FALSE if the given directory isn't found or readable |
void nntpgrab_config_free_folder_listing (NNTPGrabGlue *obj
,NGList *folders
);
ngboolean nntpgrab_schedular_start (NNTPGrabGlue *obj
);
Start the NNTPGrab schedular
|
An instance of the NNTPGrabGlue |
Returns : |
TRUE is the schedular was successfully started, FALSE if the schedular was already running or in the 'stopping' state |
ngboolean nntpgrab_schedular_stop (NNTPGrabGlue *obj
,ngboolean wait
);
Stop the NNTPGrab schedular
|
An instance of the NNTPGrabGlue |
|
Whether this function should wait until the schedular really has stopped |
Returns : |
TRUE is schedular was successfully stopped, FALSE if the schedular was already stopped or the in 'stopping' state |
NGSchedularState nntpgrab_schedular_get_state (NNTPGrabGlue *obj
);
Retrieve the current state of the schedular
|
An instance of the NNTPGrabGlue |
Returns : |
The current state of the schedular |
ngboolean nntpgrab_schedular_add_task_to_queue (NNTPGrabGlue *obj
,const char *collection_name
,const char *subject
,const char *poster
,time_t stamp
,nguint64 file_size
,NGList *groups
,NGList *parts
,char **errmsg
);
Add a new task to the download queue
|
An instance of the NNTPGrabGlue |
|
The name of the collection in which this task should be added. If there is no collection in the download queue with the given name, it will automatically be created |
|
The subject of the file |
|
The name of the poster |
|
The UNIX timestamp of the post date |
|
The size of the file in bytes |
|
A list containing the newsgroups in which this file is posted. element-type utf8. |
|
A list containing the message-id's of all the individual parts belonging to this file. element-type NNTPGrabPart. |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE if the task was succesfully added, FALSE if an error occured (errmsg will be set) |
ngboolean nntpgrab_schedular_del_task_from_queue (NNTPGrabGlue *obj
,const char *collection_name
,const char *subject
,char **errmsg
);
Remove a task from the download queue
|
An instance of the NNTPGrabGlue |
|
The name of the collection in which the task resides |
|
The subject of the file |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE if the task was successfully removed, FALSE if an error occured (errmsg will be set) |
ngboolean nntpgrab_schedular_restart_task (NNTPGrabGlue *obj
,const char *collection_name
,const char *subject
,char **errmsg
);
Restart a task in the download queue
|
An instance of the NNTPGrabGlue |
|
The name of the collection in which the task resides |
|
The subject of the file |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE if the task was successfully removed, FALSE if an error occured (errmsg will be set) |
ngboolean nntpgrab_schedular_save_queue (NNTPGrabGlue *obj
,char **errmsg
);
Save any recent changes in the download queue to the disk. The download queue will automatically be saved every now and then by the NNTPGrab Core, but it is recommended to perform a manual save as soon as a lot of file have been added to the download queue (like directly after an NZB import)
|
An instance of the NNTPGrabGlue |
|
Pointer to a char*. If an errors occurs, the reason will be placed in this field. Needs to be freed using ngfree() . Can be NULL to ignore errors. allow-none. out. |
Returns : |
TRUE if the task was successfully removed, FALSE if an error occured (errmsg will be set) |
void nntpgrab_schedular_foreach_task (NNTPGrabGlue *obj
,ForeachCollectionFunc collection_func
,ForeachFileFunc file_func
,ForeachGroupFunc group_func
,void *data
);
Retrieve a list of all the items in the download queue (using callback functions)
|
An instance of the NNTPGrabGlue |
|
The function which should be called for every collection in the download queue. allow-none. |
|
The function which should be called for every file in the download queue. allow-none. |
|
The function which should be called for every group in every file in the download queue. allow-none. |
|
Pointer to some data which will be made available in the callback functions. allow-none. |
ngboolean nntpgrab_schedular_move_task (NNTPGrabGlue *obj
,const char *collection_name_src
,const char *subject_src
,const char *collection_name_dest
,int position_dest
);
Move a task in the download queue
|
An instance of the NNTPGrabGlue |
|
The name of the collection where the subject is part of |
|
The name of the subject which needs to be moved |
|
The name of the collection where the subject needs to be moved to (if NULL, the task will stay in the same collection as it is now). allow-none. |
|
The position in collection_name_dest where the task needs to be placed at |
Returns : |
TRUE on success, FALSE if the collection_name_src or subject_src could not be found |
ngboolean nntpgrab_schedular_move_collection (NNTPGrabGlue *obj
,const char *collection_name
,int new_position
);
Move the position of a collection in the download queue
|
An instance of the NNTPGrabGlue |
|
The name of the collection which needs to be moved |
|
The position in the download queue where the collection needs to be moved to |
Returns : |
TRUE on success, FALSE is the collection_name could not be found |
ngboolean nntpgrab_schedular_mark_task_optional (NNTPGrabGlue *obj
,const char *collection_name
,const char *subject
,ngboolean is_optional
);
Mark a task in the download queue optional or non-optional
|
An instance of the NNTPGrabGlue |
|
The name of the collection in which the task resides |
|
The subject of the task |
|
TRUE if the task needs to be marked optional, FALSE is the task needs to be marked non-optional |
Returns : |
TRUE if the task was successfully updated, FALSE if the task wasn't found |
NGList * nntpgrab_plugins_get_avail_plugins (NNTPGrabGlue *obj
);
Retrieve a list of all the available plugins
|
An instance of the NNTPGrabGlue |
Returns : |
A list containing all the available plugins (const char* items). Needs to be free'd using nntpgrab_plugins_free_avail_plugins()
|
void nntpgrab_plugins_free_avail_plugins (NNTPGrabGlue *obj
,NGList *plugins
);
ngboolean nntpgrab_plugins_get_plugin_info (NNTPGrabGlue *obj
,const char *plugin_name
,NNTPGrabPluginInfo *plugin_info
);
Retrieve information about a specific plugin
|
An instance of the NNTPGrabGlue |
|
The name of the plugin whose information needs to be retrieved |
|
Pointer to an NNTPGrabPluginInfo structure where the plugin information can be saved. out. |
Returns : |
TRUE on success, FALSE if the given plugin_name is unknown |
ngboolean nntpgrab_plugins_load_plugin (NNTPGrabGlue *obj
,const char *plugin_name
,char **errmsg
);
Load a plugin
|
An instance of the NNTPGrabGlue |
|
The name of the plugin which needs to be loaded |
|
Pointer to a location where an error message can be saved. Needs to be free'd using ng_free() . allow-none. out. |
Returns : |
TRUE on success, FALSE is the given plugin_name is unknown or an error occured while loading the plugin |
ngboolean nntpgrab_plugins_unload_plugin (NNTPGrabGlue *obj
,const char *plugin_name
,char **errmsg
);
Unload a plugin
|
An instance of the NNTPGrabGlue |
|
The name of the plugin which needs to be unloaded |
|
Pointer to a location where an error message can be saved. Needs to be free'd using ng_free() . allow-none. out. |
Returns : |
TRUE on success, FALSE is the given plugin_name is unknown or an error occured while unloading the plugin |
ngboolean nntpgrab_plugins_set_persistent (NNTPGrabGlue *obj
,const char *plugin_name
,ngboolean persistent
);
Indicate whether a plugin needs to be automatically loaded on startup This API function is unused in NNTPGrab 0.6
|
An instance of the NNTPGrabGlue |
|
The name of the plugin |
|
Flag to indicate whether this plugin needs to be automatically loaded or not |
Returns : |
TRUE on success, FALSE is the given plugin_name is unknown |
"all-downloads-completed"
signalvoid user_function (NNTPGrabGlue *obj, gpointer user_data) : Run Last / Has Details
This message is emit when all the items in the download queue are completed
|
An instance of the NNTPGrabGlue |
|
user data set when the signal handler was connected. |
"collection-added"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gchar *poster, gpointer user_data) : Run Last / Has Details
A new collection was added
|
An instance of the NNTPGrabGlue |
|
The name of the collection which was just added |
|
The poster of this collection. If multiple posters are involved, this value will be NULL. allow-none. |
|
user data set when the signal handler was connected. |
"collection-downloaded"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gpointer user_data) : Run Last / Has Details
A collection has been completely downloaded
|
An instance of the NNTPGrabGlue |
|
The name of the collection which has been fully downloaded |
|
user data set when the signal handler was connected. |
"collection-modified"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gchar *poster, gpointer user_data) : Run Last / Has Details
The poster of a collection was modified
|
An instance of the NNTPGrabGlue |
|
The name of the collection which was just changed |
|
The name of the poster of this collection. This value can be NULL if multiple posters are involved. allow-none. |
|
user data set when the signal handler was connected. |
"collection-moved"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gint old_position, gint new_position, gpointer user_data) : Run Last / Has Details
The position of a collection in the download queue has changed
|
An instance of the NNTPGrabGlue |
|
The name of the collection which has just been moved |
|
The original position in the download queue of the collection |
|
The new position in the download queue of the collection |
|
user data set when the signal handler was connected. |
"collection-removed"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gpointer user_data) : Run Last / Has Details
A collection was removed
|
An instance of the NNTPGrabGlue |
|
The name of the collection which was just removed |
|
user data set when the signal handler was connected. |
"config-changed"
signalvoid user_function (NNTPGrabGlue *obj, gpointer user_data) : Run Last / Has Details
Something in the configuration has changed
|
An instance of the NNTPGrabGlue |
|
user data set when the signal handler was connected. |
"connection-connected"
signalvoid user_function (NNTPGrabGlue *obj, gchar *servername, gint conn_id, gchar *welcome_msg, gpointer user_data) : Run Last / Has Details
A connection attempt has succeeded
|
An instance of the NNTPGrabGlue |
|
The name of the server to which a connection has just been made |
|
An identifier for this connection |
|
The welcome message which was returned from the server |
|
user data set when the signal handler was connected. |
"connection-connecting"
signalvoid user_function (NNTPGrabGlue *obj, gchar *servername, gint conn_id, gpointer user_data) : Run Last / Has Details
A new connection is being made to a usenet server
|
An instance of the NNTPGrabGlue |
|
The name of the server to which a connection is being made |
|
An identifier for this connection |
|
user data set when the signal handler was connected. |
"connection-disconnect"
signalvoid user_function (NNTPGrabGlue *obj, gchar *servername, gint conn_id, gint disconnect_type, gchar *reason, gpointer user_data) : Run Last / Has Details
A connection to a usenet server was disconnected
|
An instance of the NNTPGrabGlue |
|
The name of the server which was just disconnected |
|
An identifier for this connection |
|
One of the values from NNTPDisconnectType |
|
The reason which indicates why the disconnect occured. Can be NULL. allow-none. |
|
user data set when the signal handler was connected. |
"connection-lost"
signalvoid user_function (NNTPGrabGlue *obj, gchar *reason, gpointer user_data) : Run Last / Has Details
The connection to the NNTPGrab Server has been lost
|
An instance of the NNTPGrabGlue |
|
The reason why the connection was lost |
|
user data set when the signal handler was connected. |
"file-added"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gchar *subject, gchar *poster, guint64 stamp, guint64 file_size, guint64 total_size, guint64 total_size_remaining, gint status, gint num_parts, gpointer groups, gpointer user_data) : Run Last / Has Details
A file was added to a already existing collection
|
An instance of the NNTPGrabGlue |
|
The name of the collection in which this file belongs |
|
The subject of the file which was just added |
|
The poster of the file which was just added |
|
The stamp mentioning when the first part of this file was posted |
|
The size of this file in bytes |
|
The size of the entire collection in bytes |
|
The number of bytes which still need to be downloaded from the entire collection |
|
The current status of this file. This is of the type NGTaskState |
|
The number of parts of which this file consists |
|
A list containing the groups in which this file is posted. element-type utf8. |
|
user data set when the signal handler was connected. |
"file-download-state-update"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gchar *subject, gint num_parts_total, gint num_parts_done, gint num_parts_failed, guint64 file_size, guint64 file_size_remaining, guint64 total_size, guint64 total_size_remaining, gpointer user_data) : Run Last / Has Details
The state of a file in the download queue has changed
|
An instance of the NNTPGrabGlue |
|
The collection name |
|
The subject |
|
The number of parts of which this file consists |
|
The number of parts of this file which are already downloaded |
|
The number of parts of this file which failed to download |
|
The size of this file in bytes |
|
The number of bytes remaining from this file |
|
The total size of the entire collection in bytes |
|
The number of bytes remaining from the entire collection |
|
user data set when the signal handler was connected. |
"file-removed"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gchar *subject, guint64 total_size, guint64 total_size_remaining, gpointer user_data) : Run Last / Has Details
A file was removed from the download queue
|
An instance of the NNTPGrabGlue |
|
The name of the collection in which this file was situated |
|
The subject of the file |
|
The new total size of the entire collection |
|
The new total size remaining of the entire collection |
|
user data set when the signal handler was connected. |
"file-state-changed"
signalvoid user_function (NNTPGrabGlue *obj, gchar *collection_name, gchar *subject, gchar *real_filename, gint old_state, gint new_state, gpointer user_data) : Run Last / Has Details
A file in the download queue was restarted
|
An instance of the NNTPGrabGlue |
|
The name of the collection in which the state changed |
|
The subject of the file which changed state |
|
The file name of the physical resulting file. Will be NULL if the file isn't completely downloaded and decoded yet. allow-none. |
|
The old state of the file |
|
The new state of the file |
|
user data set when the signal handler was connected. |
"log-message"
signalvoid user_function (NNTPGrabGlue *obj, gchar *component, gint log_level, gchar *msg, gpointer user_data) : Run Last / Has Details
A log message has been emitted
|
An instance of the NNTPGrabGlue |
|
The component which emit this log message |
|
One of the values from NGLogLevel |
|
The log message which was emit |
|
user data set when the signal handler was connected. |
"part-done"
signalvoid user_function (NNTPGrabGlue *obj, gchar *servername, gint conn_id, gchar *collection_name, gchar *subject, gint part_num, gint size, gpointer user_data) : Run Last / Has Details
The download of a part has completed successfully
|
An instance of the NNTPGrabGlue |
|
The name of the server on which this part has just been downloaded |
|
The connection id which was used to download this part |
|
The name of the collection from which this part is |
|
The name of the subject from which this part is |
|
The number of the part |
|
The size of the part in bytes. This can be different from the size which was mentioned earlier in other calls like nntpgrab_core_schedular_foreach_task()
|
|
user data set when the signal handler was connected. |
"part-download-start"
signalvoid user_function (NNTPGrabGlue *obj, gchar *servername, gint conn_id, gchar *collection_name, gchar *subject, gint part_num, gpointer user_data) : Run Last / Has Details
The download of a part has just started
|
An instance of the NNTPGrabGlue |
|
The name of the server on which this part is being downloaded |
|
The connection id which is used to download this part |
|
The name of the collection from which this part is |
|
The name of the subject from which this part is |
|
The number of the part |
|
user data set when the signal handler was connected. |
"part-failed"
signalvoid user_function (NNTPGrabGlue *obj, gchar *servername, gint conn_id, gchar *collection_name, gchar *subject, gint part_num, gint size, gboolean all_servers_tried, gpointer user_data) : Run Last / Has Details
The download of a part has failed (probably because the part isn't available on the server)
|
An instance of the NNTPGrabGlue |
|
The name of the server on which this part was tried |
|
The connection id which was used to try to download this part |
|
The name of the collection from which this part is |
|
The name of the subject from which this part is |
|
The number of the part |
|
The size of the part in bytes |
|
If TRUE, all configured servers have tried to download this file and none of them succeeded |
|
user data set when the signal handler was connected. |
"part-progress-update"
signalvoid user_function (NNTPGrabGlue *obj, gchar *servername, gint conn_id, gchar *collection_name, gchar *subject, gint part_num, gint bytes_downloaded, gint bytes_total, gpointer user_data) : Run Last / Has Details
Every 1/10th second of a part download, this message will be sent
|
An instance of the NNTPGrabGlue |
|
The name of the server on which this part is being downloaded |
|
The connection id which is being used to download this part |
|
The name of the collection from which this part is |
|
The name of the subject from which this part is |
|
The number of the part |
|
The number of bytes already downloaded from this part |
|
The total size of this part in bytes. This can be different from the size which was mentioned earlier in other calls like nntpgrab_schedular_foreach_task()
|
|
user data set when the signal handler was connected. |
"plugin-event"
signalvoid user_function (NNTPGrabGlue *obj, gchar *plugin_name, gchar *event_name, GStrv *values, gpointer user_data) : Run Last / Has Details
A plugin has emit an event
|
An instance of the NNTPGrabGlue |
|
The name of the plugin |
|
The name of the plugin event |
|
The values belonging to this event. This is a NULL-terminated array |
|
user data set when the signal handler was connected. |
"plugin-loaded"
signalvoid user_function (NNTPGrabGlue *obj, gchar *plugin_name, gboolean is_persistent, gpointer user_data) : Run Last / Has Details
A plugin has been loaded
|
An instance of the NNTPGrabGlue |
|
The name of the plugin |
|
Unused in NNTPGrab 0.7 |
|
user data set when the signal handler was connected. |
"plugin-unloaded"
signalvoid user_function (NNTPGrabGlue *obj, gchar *plugin_name, gpointer user_data) : Run Last / Has Details
A plugin has been unloaded
|
An instance of the NNTPGrabGlue |
|
The name of the plugin |
|
user data set when the signal handler was connected. |
"schedular-state-changed"
signalvoid user_function (NNTPGrabGlue *obj, gint new_state, gchar *reason, gpointer user_data) : Run Last / Has Details
The state of the schedular has changed
|
An instance of the NNTPGrabGlue |
|
The new state of the schedular |
|
The reason why the schedular changed state. Will be NULL if it's caused by request of the user (nntpgrab_core_schedular_start() / nntpgrab_core_schedular_stop() ). allow-none. |
|
user data set when the signal handler was connected. |
"task-moved"
signalvoid user_function (NNTPGrabGlue *obj, gchar *orig_collection_name, gchar *subject, gchar *new_collection_name, gint old_position, gint new_position, gpointer user_data) : Run Last / Has Details
The position of a task in the download queue has changed
|
An instance of the NNTPGrabGlue |
|
The name of the original collection of which the file was a member of |
|
The subject of the file |
|
The name of the new collection to which the file is moved (which can be the same of orig_collection_name )
|
|
The original position of the file in the original collection |
|
The new position of the file in the new collection |
|
user data set when the signal handler was connected. |
"traffic-monitor-update"
signalvoid user_function (NNTPGrabGlue *obj, gint bytes_received1, gint bytes_received2, gint bytes_received3, gint bytes_received4, gint bytes_received5, gint bytes_received6, gint bytes_received7, gint bytes_received8, gint bytes_received9, gint bytes_received10, gint64 stamp, gdouble average, gpointer user_data) : Run Last / Has Details
Every second, traffic statistics about the last 10 seconds are given
|
An instance of the NNTPGrabGlue |
|
The number of bytes received in now() - 10
|
|
The number of bytes received in now() - 9
|
|
The number of bytes received in now() - 8
|
|
The number of bytes received in now() - 7
|
|
The number of bytes received in now() - 6
|
|
The number of bytes received in now() - 5
|
|
The number of bytes received in now() - 4
|
|
The number of bytes received in now() - 3
|
|
The number of bytes received in now() - 2
|
|
The number of bytes received in now() - 1
|
|
The timestamp of the last measurement |
|
The average number of bytes per second |
|
user data set when the signal handler was connected. |