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 (nickname etc) */

    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

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

    43

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

    44

 *

    45

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

    46

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

    47

 *

    48

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

    49

 *

    50

 * XXX: needs some callbacks

    51

 */

    52

struct irc_net {

    53

    /** The current connection */

    54

    struct irc_conn *conn;

    55

    56

    /** Our connection info */

    57

    struct irc_net_info info;

    58

    59

    /** The list of IRC channel states */

    60

    TAILQ_HEAD(irc_net_chan_list, irc_chan) channels;

    61

    62

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

    63

    LIST_HEAD(irc_net_users_list, irc_user) users;

    64

    65

    /** The irc_client list */

    66

    TAILQ_ENTRY(irc_net) client_networks;

    67

};

    68

    69

/**

    70

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

    71

 */

    72

const char* irc_net_name (struct irc_net *net);

    73

    74

/**

    75

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

    76

 *

    77

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

    78

 *

    79

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

    80

 *

    81

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

    82

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

    83

 * @param err return error info

    84

 */

    85

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

    86

    87

/**

    88

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

    89

 * well.

    90

 */

    91

void irc_net_destroy (struct irc_net *net);

    92

    93

/**

    94

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

    95

 *

    96

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

    97

 *

    98

 * @param net the irc_net the channel is on

    99

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

   100

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

   101

 * @param err return error info

   102

 */

   103

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);

   104

   105

/**

   106

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

   107

 *

   108

 * @param net the network context

   109

 * @param channel the channel name

   110

 */

   111

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

   112

   113

/**

   114

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

   115

 *

   116

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

   117

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

   118

 *

   119

 * @param user_ptr set to the new irc_user state

   120

 * @param net the network context

   121

 * @param nickname the user's current nickname

   122

 */

   123

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

   124

   125

/**

   126

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

   127

 */

   128

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

   129

   130

/**

   131

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

   132

 *

   133

 * XXX: nothing to indicate completion

   134

 */

   135

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

   136

   137

#endif