plugin.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
#ifndef MPTCPD_PLUGIN_H
#define MPTCPD_PLUGIN_H
 
#include <stdbool.h>
 
#include <mptcpd/export.h>
#include <mptcpd/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct sockaddr;
struct mptcpd_pm;
struct mptcpd_interface;
 
#define MPTCPD_PLUGIN_SYM _mptcpd_plugin
 
#define MPTCPD_PLUGIN_DEFINE(name, description, priority, init, exit)   \
        extern struct mptcpd_plugin_desc const MPTCPD_PLUGIN_SYM        \
                __attribute__((visibility("default")));                 \
        struct mptcpd_plugin_desc const MPTCPD_PLUGIN_SYM = {           \
                #name,                                                  \
                description,                                            \
                0, /* version */                                        \
                priority,                                               \
                init,                                                   \
                exit                                                    \
        };
 
#define MPTCPD_PLUGIN_PRIORITY_LOW     19
 
#define MPTCPD_PLUGIN_PRIORITY_DEFAULT 0
 
#define MPTCPD_PLUGIN_PRIORITY_HIGH    -20
 
struct mptcpd_plugin_desc
{
        char const *const name;
 
        char const *const description;
 
        char const *const version;
 
        int const priority;
 
        int (*init)(struct mptcpd_pm *);
 
        void (*exit)(struct mptcpd_pm *);
};
 
struct mptcpd_plugin_ops
{
 
        void (*new_connection)(mptcpd_token_t token,
                               struct sockaddr const *laddr,
                               struct sockaddr const *raddr,
                               bool server_side,
                               bool deny_join_id0,
                               struct mptcpd_pm *pm);
 
        void (*connection_established)(mptcpd_token_t token,
                                       struct sockaddr const *laddr,
                                       struct sockaddr const *raddr,
                                       bool server_side,
                                       bool deny_join_id0,
                                       struct mptcpd_pm *pm);
 
        void (*connection_closed)(mptcpd_token_t token,
                                  struct mptcpd_pm *pm);
 
        void (*new_address)(mptcpd_token_t token,
                            mptcpd_aid_t id,
                            struct sockaddr const *addr,
                            struct mptcpd_pm *pm);
 
        void (*address_removed)(mptcpd_token_t token,
                                mptcpd_aid_t id,
                                struct mptcpd_pm *pm);
 
        void (*new_subflow)(mptcpd_token_t token,
                            struct sockaddr const *laddr,
                            struct sockaddr const *raddr,
                            bool backup,
                            struct mptcpd_pm *pm);
 
        void (*subflow_closed)(mptcpd_token_t token,
                               struct sockaddr const *laddr,
                               struct sockaddr const *raddr,
                               bool backup,
                               uint8_t error,
                               struct mptcpd_pm *pm);
 
        void (*subflow_priority)(mptcpd_token_t token,
                                 struct sockaddr const *laddr,
                                 struct sockaddr const *raddr,
                                 bool backup,
                                 struct mptcpd_pm *pm);
 
        void (*listener_created)(struct sockaddr const *laddr,
                                 struct mptcpd_pm *pm);
 
        void (*listener_closed)(struct sockaddr const *laddr,
                                struct mptcpd_pm *pm);
 
        // --------------------------------------------------------
 
 
        void (*new_interface)(struct mptcpd_interface const *i,
                              struct mptcpd_pm *pm);
 
        void (*update_interface)(struct mptcpd_interface const *i,
                                 struct mptcpd_pm *pm);
 
        void (*delete_interface)(struct mptcpd_interface const *i,
                                 struct mptcpd_pm *pm);
 
        void (*new_local_address)(struct mptcpd_interface const *i,
                                  struct sockaddr const *sa,
                                  struct mptcpd_pm *pm);
 
        void (*delete_local_address)(struct mptcpd_interface const *i,
                                     struct sockaddr const *sa,
                                     struct mptcpd_pm *pm);
};
 
MPTCPD_API bool mptcpd_plugin_register_ops(
        char const *name,
        struct mptcpd_plugin_ops const *ops);
 
#ifdef __cplusplus
}
#endif
 
#endif  // MPTCPD_PLUGIN_H
 
 
/*
  Local Variables:
  c-file-style: "linux"
  End:
*/