1

#ifndef IRC_CHAN_H

     2

#define IRC_CHAN_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * Support for IRC channels, including tracking their state and actions on them.

     8

 */

     9

struct irc_chan_info;

    10

struct irc_chan;

    11

    12

#include "irc_net.h"

    13

#include "irc_cmd.h"

    14

#include "error.h"

    15

#include <sys/queue.h>

    16

    17

/**

    18

 * IRC channel info, as required to create an irc_chan

    19

 */

    20

struct irc_chan_info {

    21

    /** Channel name, with the [#&!] prefix */

    22

    const char *channel;

    23

    24

};

    25

    26

/**

    27

 * Semantic IRC channel callbacks

    28

 */

    29

struct irc_chan_callbacks {

    30

    /** Joined the channel */

    31

    void (*on_self_join) (struct irc_chan *chan, void *arg);

    35

};

    36

    37

/**

    53

 * IRC channel state

    54

 */

    55

struct irc_chan {

    56

    /** The irc_net.channels list */

    57

    TAILQ_ENTRY(irc_chan) node;

    58

    59

    /* The network we're on */

    60

    struct irc_net *net;

    61

    62

    /** Our identifying info */

    63

    struct irc_chan_info info;

    64

    65

    /** State flags */

    66

    struct {

    67

        /** JOIN request sent, waiting for reply */

    68

        bool joining;

    69

    70

        /** Currently joined to channel */

    71

        bool joined;

    72

    73

    } state;

    74

    75

    /** General command handlers */

    76

    irc_cmd_handlers_t handlers;

    80

};

    81

    82

/**

    83

 * Return the channel's name

    84

 */

    85

const char* irc_chan_name (struct irc_chan *chan);

    86

    87

/**

    88

 * Build/initialize a new irc_chan struct. This does not have any external side-effects.

    89

 *

    90

 * The channel will be in the IRC_CHAN_INIT state after this.

    91

 *

    92

 * @param chan_ptr the new irc_chan is returned via this pointer

    93

 * @param net the irc_net this channel is on

    94

 * @param info the channel's identifying information

    95

 * @param err error codes are returned via this

    96

 */

    97

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

    98

    99

/**

   100

 * Destroy irc_chan state, without doing anything to the network

   101

 */

   102

void irc_chan_destroy (struct irc_chan *chan);

   103

   104

/**

   110

 * Send the initial JOIN message.

   111

 *

   112

 * The channel must be in the IRC_CHAN_INIT state, and will transition to the IRC_CHAN_JOINING state.

   113

 *

   114

 * @param chan the channel to JOIN

   115

 */

   116

err_t irc_chan_join (struct irc_chan *chan);

   117

   118

   119

#endif