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

    11

struct irc_net;

    12

    13

#include "error.h"

    14

#include "irc_conn.h"

    15

#include "irc_chan.h"

    16

#include <sys/queue.h>

    17

    18

/**

    19

 * Configuration info for an IRC network

    20

 */

    21

struct irc_net_info {

    22

    /** The name of the network */

    23

    const char *network;

    24

    25

    /** The hostname to connect to */

    26

    const char *hostname;

    27

    28

    /** Service name (port) */

    29

    const char *service;

    30

    31

    /** SSL? */

    32

    bool use_ssl;

    33

    34

    /** Protocol registration info */

    35

    struct irc_conn_register_info register_info;

    36

    37

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

    38

    struct sock_stream *raw_sock;

    39

};

    40

    41

/**

    42

 * IRC Network state

    43

 */

    44

struct irc_net {

    45

    /* The current connection */

    46

    struct irc_conn *conn;

    47

    48

    /** Our connection info */

    49

    struct irc_net_info info;

    50

    51

    /** The list of IRC channel states */

    52

    TAILQ_HEAD(irc_net_chan_list, irc_chan) channels;

    53

    54

    /** Our set of valid irc_user items for use with irc_chan */

    55

    LIST_HEAD(irc_net_users_list, irc_user) users;

    56

    57

    /** The irc_client list */

    58

    TAILQ_ENTRY(irc_net) client_networks;

    59

};

    60

    61

/**

    62

 * Return the networks's name

    63

 */

    64

const char* irc_net_name (struct irc_net *net);

    65

    66

/**

    67

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

    68

 *

    69

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

    70

 *

    71

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

    72

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

    73

 * @param err return error info

    74

 */

    75

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

    76

    77

/**

    78

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

    79

 * well.

    80

 */

    81

void irc_net_destroy (struct irc_net *net);

    82

    83

/**

    84

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

    85

 *

    86

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

    87

 *

    88

 * @param net the irc_net the channel is on

    89

 * #param chan_ptr return the new irc_chan via this, if not NULL

    90

 * @param info the info required to identify and join the channel

    91

 * @param err return error info

    92

 */

    93

err_t irc_net_add_chan (struct irc_net *net, struct irc_chan **chan_ptr, const struct irc_chan_info *info, struct error_info *err);

    94

    95

/**

    96

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

    97

 *

    98

 * @param net the network context

    99

 * @param channel the channel name

   100

 */

   101

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

   102

   103

/**

   104

 * Look up an existing irc_user by nickname, or create a new one if not found.

   105

 *

   109

 * @param user_ptr set to the new irc_user state

   110

 * @param net the network context

   111

 * @param nickname the user's current nickname

   112

 */

   113

err_t irc_net_get_user (struct irc_net *net, struct irc_user **user_ptr, const char *nickname);

   114

   115

/**

   121

 * Quit from the IRC network, this sends a QUIT message to the server, and waits for the connection to be closed cleanly.

   122

 */

   123

err_t irc_net_quit (struct irc_net *net, const char *message);

   124

   125

#endif