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 "irc_conn.h"

    14

#include "irc_chan.h"

    17

#include <sys/queue.h>

    18

    19

/**

    20

 * Configuration info for an IRC network

    21

 */

    22

struct irc_net_info {

    23

    /** The name of the network */

    24

    const char *network;

    25

    26

    /** The hostname to connect to */

    27

    const char *hostname;

    28

    29

    /** Service name (port) */

    30

    const char *service;

    31

    32

    /** Use SSL if given as non-NULL, a reference will be held by the irc_net */

    33

    struct ssl_client_cred *ssl_cred;

    34

    35

    /** Protocol registration info (nickname etc) */

    36

    struct irc_conn_register_info register_info;

    37

    38

    /** Alternatively, raw transport to use, mainly for testing purposes */

    39

    transport_t *transport;

    40

};

    41

    42

/**

    43

 * The persistent IRC network state. This includes the "current" connection (which may change over time), the

    44

 * identifying info, the list of channels and their state, etc.

    45

 *

    46

 * This handles the irc_conn's messages, and propagates relevant messages to the appropriate irc_chan

    47

 * (using irc_chan::handlers). This includes NICK/QUIT events for users on said channel.

    48

 *

    49

 * For NICK events, the event is propagated *before* updating irc_user::nickname.

    50

 *

    51

 * XXX: needs some callbacks

    52

 */

    53

struct irc_net {

    54

    /** The current connection */

    55

    struct irc_conn *conn;

    56

    57

    /** Our connection info */

    58

    struct irc_net_info info;

    59

    60

    /** Are we currently connecting? */

    61

    bool connecting;

    62

    63

    /** Are we connected? */

    64

    bool connected;

    65

    66

    /** Succesfull connect time */

    67

    time_t connected_ts;

    68

    69

    /** The list of IRC channel states */

    70

    TAILQ_HEAD(irc_net_chan_list, irc_chan) channels;

    71

    72

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

    73

    LIST_HEAD(irc_net_users_list, irc_user) users;

    74

    75

    /** Reconnect timer */

    76

    struct event *reconnect_timer;

    77

    78

    /** The irc_client list */

    79

    TAILQ_ENTRY(irc_net) client_networks;

    80

};

    81

    82

/**

    83

 * Return the network's name, as per irc_net_info::network

    84

 */

    85

const char* irc_net_name (struct irc_net *net);

    86

    87

/**

    88

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

    89

 *

    90

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

    91

 *

    92

 * The irc_net_info struct itself is copied, but the strings contained therein are not...

    93

 *

    94

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

    95

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

    96

 * @param err return error info

    97

 */

    98

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

    99

   100

/**

   101

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

   102

 * well.

   103

 */

   104

void irc_net_destroy (struct irc_net *net);

   105

   106

/**

   107

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

   108

 *

   109

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

   110

 *

   111

 * @param net the irc_net the channel is on

   112

 * @param chan_ptr return the new irc_chan via this, if given

   113

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

   114

 * @param err return error info

   115

 */

   116

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

   117

   118

/**

   119

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

   120

 *

   121

 * @param net the network context

   122

 * @param channel the channel name

   123

 */

   124

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

   125

   126

/**

   127

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

   128

 *

   129

 * This will increment the reference count on the irc_user object, so do call irc_net_put_user once you're done with

   130

 * it, or you'll get reference-counting bugs...

   131

 *

   132

 * @param user_ptr set to the new irc_user state

   133

 * @param net the network context

   134

 * @param nickname the user's current nickname

   135

 */

   136

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

   137

   138

/**

   139

 * Release a previously get'd irc_user, decrementing its refcount and destroying it if unused.

   140

 */

   141

void irc_net_put_user (struct irc_net *net, struct irc_user *user);

   142

   143

/**

   144

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

   145

 *

   146

 * XXX: nothing to indicate completion

   147

 */

   148

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

   149

   150

#endif