1

#ifndef IRC_NET_H

     2

#define IRC_NET_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * Support for IRC networks. This is similar to an IRC connection, but we keep track of channel state, and handle

     8

 * reconnects.

     9

 */

    10

#include "error.h"

    11

#include "irc_conn.h"

    12

#include "irc_chan.h"

    13

#include <sys/queue.h>

    14

    15

/**

    16

 * Configuration info for an IRC network

    17

 */

    18

struct irc_net_info {

    19

    /** The name of the network */

    20

    const char *network;

    21

    22

    /** The hostname to connect to */

    23

    const char *hostname;

    24

    25

    /** Service name (port) */

    26

    const char *service;

    27

    28

    /** SSL? */

    29

    bool use_ssl;

    30

    31

    /** Protocol registration info */

    32

    struct irc_conn_register_info register_info;

    33

    34

    /** Raw socket to use, mainly for testing purposes */

    35

    struct sock_stream *raw_sock;

    36

};

    37

    38

/**

    39

 * IRC Network state

    40

 */

    41

struct irc_net {

    42

    /* The current connection */

    43

    struct irc_conn *conn;

    44

    45

    /** The list of IRC channel states */

    46

    TAILQ_HEAD(irc_net_chan_list, irc_chan) channels;

    47

};

    48

    49

/**

    50

 * Create a new IRC network state, using the given network info to connect/register.

    51

 *

    52

 * Errors are returned via *err, also returning the error code.

    53

 *

    54

 * @param net the new irc_net struct is returned via this pointer

    55

 * @param info network informated, used to connect and register

    56

 * @param err used to return extended error information

    57

 */

    58

err_t irc_net_create (struct irc_net **net, const struct irc_net_info *info, struct error_info *err);

    59

    60

/**

    61

 * Destroy an irc_net state without closing anything cleanly. This destroys the irc_conn, if any, and any irc_chans as

    62

 * well.

    63

 */

    64

void irc_net_destroy (struct irc_net *net);

    65

    66

/**

    67

 * Create a new irc_chan and add it to our channel list.

    68

 *

    69

 * If we are connected and registered, JOIN the channel right away, otherwise, join it once we register.

    70

 */

    71

struct irc_chan* irc_net_add_chan (struct irc_net *net, const struct irc_chan_info *info);

    72

    73

/**

    74

 * Look up an existing irc_chan by name, returning NULL if not found.

    75

 *

    76

 * @param net the network state

    77

 * @param channel the channel name

    78

 */

    79

struct irc_chan* irc_net_get_chan (struct irc_net *net, const char *channel);

    80

    86

#endif