Netdude Manual
Prev |  | Next

# nd_protocol_plugin

## Name

nd_protocol_plugin --

## Synopsis

    void        (*ND_ProtoPluginFunc)           (ND_ProtoPlugin *plugin,
                                                 void *user_data);
    void        nd_proto_plugin_init            (void);
    const char* nd_proto_plugin_get_description (ND_ProtoPlugin *pp);
    const char* nd_proto_plugin_get_author      (ND_ProtoPlugin *pp);
    const char* nd_proto_plugin_get_version     (ND_ProtoPlugin *pp);
    const char* nd_proto_plugin_get_name        (ND_ProtoPlugin *pp);
    void        nd_proto_plugin_show_about      (ND_ProtoPlugin *pp);
    void        nd_proto_plugin_foreach         (ND_ProtoPluginFunc callback,
                                                 void *user_data);

## Description

## Details

### ND_ProtoPluginFunc ()

    void        (*ND_ProtoPluginFunc)           (ND_ProtoPlugin *plugin,
                                                 void *user_data);

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

`plugin` :

  iterated plugin.

`user_data` :

  arbitrary user data.

### nd_proto_plugin_init ()

    void        nd_proto_plugin_init            (void);

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

### nd_proto_plugin_get_description ()

    const char* nd_proto_plugin_get_description (ND_ProtoPlugin *pp);

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

`pp` :

  plugin to query.

Returns :

  description string.

### nd_proto_plugin_get_author ()

    const char* nd_proto_plugin_get_author      (ND_ProtoPlugin *pp);

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

`pp` :

  plugin to query.

Returns :

  author name string.

### nd_proto_plugin_get_version ()

    const char* nd_proto_plugin_get_version     (ND_ProtoPlugin *pp);

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

`pp` :

  plugin to query.

Returns :

  version string.

### nd_proto_plugin_get_name ()

    const char* nd_proto_plugin_get_name        (ND_ProtoPlugin *pp);

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

`pp` :

  plugin to query.

Returns :

  plugin name.

### nd_proto_plugin_show_about ()

    void        nd_proto_plugin_show_about      (ND_ProtoPlugin *pp);

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

`pp` :

  plugin whose About info is shown.

### nd_proto_plugin_foreach ()

    void        nd_proto_plugin_foreach         (ND_ProtoPluginFunc callback,
                                                 void *user_data);

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

`callback` :

  callback to call for each plugin.

`user_data` :

  arbitrary user data passed through to `callback`.

Prev | Home | Next
nd_protocol_inst | Up | nd_raw_protocol