1

#ifndef IRC_CLIENT_H

     2

#define IRC_CLIENT_H

     3

     4

/**

     5

 * @file

     6

 * 

     7

 * Defines the high-level, full-featured IRC 'client' state, which essentially manipulates a set of irc_net's

     8

 */

     9

#include "irc_net.h"

    10

#include <sys/queue.h>

    11

    12

/**

    13

 * Defaults for irc_client operation, mostly add_net

    14

 */

    15

struct irc_client_defaults {

    16

    /** Default nickname/username/etc to use */

    17

    struct irc_conn_register_info register_info;

    18

    19

    /** Default service (port) to use for non-SSL connections */

    20

    const char *service;

    21

    22

    /** Default service (port) to use for SSL connections */

    23

    const char *service_ssl;

    24

};

    25

    26

/**

    27

 * High-level IRC client state, this just means a set of named irc_net's and some common behaviour.

    28

 */

    29

struct irc_client {

    30

    /** Default parameters */

    31

    struct irc_client_defaults defaults;

    32

    33

    /** Our set of configured IRC networks */

    34

    TAILQ_HEAD(irc_client_networks, irc_net) networks;

    35

    36

    /** Are we in the process of quitting all networks? */

    37

    bool quitting;

    38

    39

    /** Have we quit all networks? */

    40

    bool quit;

    41

};

    42

    43

/**

    44

 * Construct a new irc_client

    45

 */

    46

err_t irc_client_create (struct irc_client **client_ptr, struct error_info *err);

    47

    48

/**

    49

 * Destroy the irc_client, also destroying all networks

    50

 */

    51

void irc_client_destroy (struct irc_client *client);

    52

    53

/**

    54

 * Set the default parameters to use for e.g. add_net.

    55

 *

    56

 * The irc_client_defaults struct itself is copied, but not its contents.

    57

 *

    58

 * @param client the IRC client

    59

 * @param defaults the defaults to use, not copied

    60

 */

    61

void irc_client_set_defaults (struct irc_client *client, const struct irc_client_defaults *defaults);

    62

    63

/**

    64

 * Add a new IRC network, using any default values set using irc_client_set_defaults() to replace NULL values in the

    65

 * given \a net_info.

    66

 *

    67

 * Use of raw_socket is not supported.

    68

 *

    69

 * @param client the irc_client state

    70

 * @param net_ptr used to return the new irc_net if not NULL

    71

 * @param net_info info required to identify and connect to the network

    72

 * @param err returned error info

    73

 */

    74

err_t irc_client_add_net (struct irc_client *client, struct irc_net **net_ptr, const struct irc_net_info *net_info, struct error_info *err);

    75

    76

/**

    77

 * Get a pre-existing IRC network by name

    78

 */

    79

struct irc_net* irc_client_get_net (struct irc_client *client, const char *network);

    80

    81

/**

    82

 * Get an irc_chan by network/channel name

    83

 */

    84

struct irc_chan* irc_client_get_chan (struct irc_client *client, const char *network, const char *channel);

    85

    86

/**

    87

 * Quit cleanly from all our IRC networks.

    88

 *

    89

 * XXX: currently no way to indicate once we've quit all of them

    90

 */

    91

err_t irc_client_quit (struct irc_client *client, const char *message);

    92

    93

#endif