Netdude Manual
Prev |  | Next

# nd_plugin

## Name

nd_plugin --

## Synopsis

    void        (*ND_PluginFunc)                (ND_Plugin *plugin,
                                                 void *user_data);
    void        nd_plugin_init                  (void);
    void        nd_plugin_run                   (ND_Plugin *plugin);
    const char* nd_plugin_get_name              (ND_Plugin *plugin);
    const char* nd_plugin_get_description       (ND_Plugin *plugin);
    const char* nd_plugin_get_author            (ND_Plugin *plugin);
    const char* nd_plugin_get_version           (ND_Plugin *plugin);
    void        nd_plugin_show_about            (ND_Plugin *plugin);
    void        nd_plugin_foreach               (ND_PluginFunc callback,
                                                 void *user_data);

## Description

## Details

### ND_PluginFunc ()

    void        (*ND_PluginFunc)                (ND_Plugin *plugin,
                                                 void *user_data);

This is the signature of functions that can be passed to `nd_plugin_foreach()`.

`plugin` :

  iterated plugin.

`user_data` :

  arbitrary user data.

### nd_plugin_init ()

    void        nd_plugin_init                  (void);

The function scans the plugin directories, reads in the plugins it finds and hooks them into the main window.

### nd_plugin_run ()

    void        nd_plugin_run                   (ND_Plugin *plugin);

The function runs the given `plugin` on the current trace. If there is no current trace, it just returns.

`plugin` :

  plugin to run.

### nd_plugin_get_name ()

    const char* nd_plugin_get_name              (ND_Plugin *plugin);

The function returns a pointer to statically allocated memory containing the plugin's name.

`plugin` :

  plugin to query.

Returns :

  plugin name.

### nd_plugin_get_description ()

    const char* nd_plugin_get_description       (ND_Plugin *plugin);

The function returns a pointer to statically allocated memory containing a string describing the plugin.

`plugin` :

  plugin to query.

Returns :

  description string.

### nd_plugin_get_author ()

    const char* nd_plugin_get_author            (ND_Plugin *plugin);

The function returns a pointer to statically allocated memory containing a string with the author's name.

`plugin` :

  plugin to query.

Returns :

  author name string.

### nd_plugin_get_version ()

    const char* nd_plugin_get_version           (ND_Plugin *plugin);

The function returns a pointer to statically allocated memory containing the plugin's version string.

`plugin` :

  plugin to query.

Returns :

  version string.

### nd_plugin_show_about ()

    void        nd_plugin_show_about            (ND_Plugin *plugin);

The function shows the About dialog for `plugin`, containing version and author info, a description etc.

`plugin` :

  plugin whose About info is shown.

### nd_plugin_foreach ()

    void        nd_plugin_foreach               (ND_PluginFunc callback,
                                                 void *user_data);

The function iterates over the registered plugins and applies a callback function to each of them.

`callback` :

  callback to call for each plugin.

`user_data` :

  arbitrary user data passed through to `callback`.

Prev | Home | Next
nd_packet | Up | nd_prefs