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

 * XXX: rename to something else

    10

 */

    11

#include "irc_net.h"

    12

#include <sys/queue.h>

    13

    14

/**

    15

 * Defaults for irc_client operation, mostly add_net

    16

 */

    17

struct irc_client_defaults {

    18

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

    19

    struct irc_conn_register_info register_info;

    20

    21

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

    22

    const char *service;

    23

    24

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

    25

    const char *service_ssl;

    26

};

    27

    28

/**

    29

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

    30

 */

    31

struct irc_client {

    32

    /** Default parameters */

    33

    struct irc_client_defaults defaults;

    34

    35

    /** Our set of configured IRC networks */

    36

    TAILQ_HEAD(irc_client_networks, irc_net) networks;

    37

    38

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

    39

    bool quitting;

    40

    41

    /** Have we quit all networks? */

    42

    bool quit;

    43

};

    44

    45

/**

    46

 * Construct a new irc_client

    47

 */

    48

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

    49

    50

/**

    51

 * Destroy the irc_client, also destroying all networks

    52

 */

    53

void irc_client_destroy (struct irc_client *client);

    54

    55

/**

    56

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

    57

 *

    58

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

    59

 *

    60

 * @param client the IRC client

    61

 * @param defaults the defaults to use, not copied

    62

 */

    63

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

    64

    65

/**

    66

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

    67

 * given \a net_info.

    68

 *

    69

 * Use of raw_socket is not supported.

    70

 *

    71

 * @param client the irc_client state

    72

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

    73

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

    74

 * @param err returned error info

    75

 */

    76

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

    77

    78

/**

    79

 * Get a pre-existing IRC network by name

    80

 */

    81

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

    82

    83

/**

    84

 * Get an irc_chan by network/channel name

    85

 */

    86

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

    87

    88

/**

    89

 * Quit cleanly from all our IRC networks.

    90

 *

    91

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

    92

 */

    93

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

    94

    95

#endif