1

#ifndef NEXUS_H

     2

#define NEXUS_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * A nexus is the central brain of the application; the place where the main() method is implemented

     8

 */

     9

struct nexus;

    10

    11

#include <event2/event.h>

    12

#include "signals.h"

    13

#include "module.h"

    14

#include "irc_client.h"

    15

#include "nexus_lua.h"

    16

#include "lua_console.h"

    17

    18

/**

    19

 * The central brain, as created in the main() function.

    20

 */

    21

struct nexus {

    22

    /** The libevent base */

    23

    struct event_base *ev_base;

    24

    25

    /** Our signal handlers */

    26

    struct signals *signals;

    27

    28

    /** Our loaded modules */

    29

    struct modules *modules;

    30

    31

    /** The IRC client state */

    32

    struct irc_client *client;

    33

    34

    /** Our lua state */

    35

    struct nexus_lua *lua;

    36

    37

    /** Our lua console */

    38

    struct lua_console *lua_console;

    39

    40

    /** Shutting down? */

    41

    bool shutdown;

    42

};

    43

    44

/**

    45

 * Load a config file into the nexus from the given path

    46

 */

    47

err_t nexus_load_config (struct nexus *nexus, const char *path, struct error_info *err);

    48

    49

/**

    50

 * Shut down the nexus cleanly. It /should/ be safe to call this several times, but it won't do anything.

    51

 *

    52

 * Once everything has shut down nicely (which it should, unless there's something buggy), the event loop should exit,

    53

 * and the main() function return.

    54

 */

    55

void nexus_shutdown (struct nexus *nexus);

    56

    57

/**

    58

 * Shut down the nexus fast. This will stop the event loop right away, which should lead to nexus_destroy being called.

    59

 */

    60

void nexus_crash (struct nexus *nexus);

    61

    62

/**

    63

 * Destroy the nexus directly. This is intended to be used once the event loop as exited.

    64

 */

    65

void nexus_destroy (struct nexus *nexus);

    66

    67

/**

    68

 * The nexus main function, application entry point, etc.

    69

 */

    70

int main (int argc, char **argv);

    71

    72

#endif /* NEXUS_H */