1

#ifndef IRC_CONN_H

     2

#define IRC_CONN_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * Support for connections to IRC servers, a rather fundamental thing. This holds the line_proto to handle the network

     8

 * communications, and then takes care of sending/receiving commands, as well as updating some core state like

     9

 * current nickname.

    10

 */

    11

    12

struct irc_conn;

    13

    14

#include "error.h"

    15

#include "sock.h"

    16

#include "line_proto.h"

    17

#include "irc_line.h"

    18

#include "irc_cmd.h"

    19

#include <stdbool.h>

    20

    21

/**

    22

 * The info required to register with irc_conn_register

    23

 */

    24

struct irc_conn_register_info {

    25

    /* Nickname to use on that server */

    26

    const char *nickname;

    27

    28

    /* Username to supply */

    29

    const char *username;

    30

    31

    /* Realname to supply */

    32

    const char *realname;

    33

};

    34

    35

/**

    36

 * Connection state callbacks

    37

 */

    38

struct irc_conn_callbacks {

    39

    /**

    40

     * irc_conn_register has completed.

    41

     */

    42

    void (*on_registered) (struct irc_conn *conn, void *arg);

    49

};

    50

    51

/*

    52

 * Connection state

    53

 */

    54

struct irc_conn {

    55

    /* We are a line-based protocol */

    56

    struct line_proto *lp;

    57

    58

    /** Callbacks */

    59

    struct irc_conn_callbacks callbacks;

    60

    61

    /** Opaque argument for callbacks */

    62

    void *cb_arg;

    63

    64

    /** @group flags @{ */

    65

    /** Registration request sent */

    66

    bool registering;

    67

    68

    /** Registered (as in, we have a working nickname)? */

    69

    bool registered;

    70

    71

    // @}

    72

    73

    /** Our current real nickname */

    74

    char *nickname;

    75

    76

    /** Command handlers */

    77

    irc_cmd_handlers_t handlers;

    78

};

    79

    80

/**

    81

 * Create a new irc_conn using the given sock_stream, which should be connected to an IRC server.

    82

 *

    83

 * This does not yet send any requests to the server, it only sets up the core state. Use irc_conn_register to register

    84

 * with the server.

    85

 *

    86

 * On success, the resulting irc_conn is returned via *conn with SUCCESS. Otherwise, -ERR_* and error info is returned

    87

 * via *err.

    88

 *

    89

 * @param conn the new irc_conn structure is returned via this pointer

    90

 * @param sock the socket connected to the IRC server

    91

 * @param err errors are returned via this pointer

    92

 * @return error code

    93

 */

    94

err_t irc_conn_create (struct irc_conn **conn, struct sock_stream *sock, const struct irc_conn_callbacks *callbacks, 

    95

        void *cb_arg, struct error_info *err);

    96

    97

/**

    98

 * Destroy the irc_conn state, terminating any connection and releasing all resources.

    99

 *

   100

 * This does not end the session cleanly, and is intended mainly to be used after clean exit, or to clean up after errors.

   101

 */

   102

void irc_conn_destroy (struct irc_conn *conn);

   103

   104

/**

   105

 * Add a new chain of command handler callbacks to be used to handle irc_lines from the server. The given arg will be

   106

 * passed to the callbacks as the context argument. The chain will be appended to the end of the current list of chains.

   107

 *

   108

 * XXX: rename to not conflict with irc_conn_register()

   109

 *

   110

 * @param chain the array of irc_cmd_handler structs, terminated with a NULL entry

   111

 * @param arg the context argument to use for the callbacks

   112

 */

   113

err_t irc_conn_add_cmd_handlers (struct irc_conn *conn, struct irc_cmd_handler *handlers, void *arg);

   114

   115

/**

   116

 * Register with the IRC server using the given registration info (initial nickname etc.)

   117

 *

   118

 * This sends the NICK/USER command sequence.

   119

 */

   120

err_t irc_conn_register (struct irc_conn *conn, const struct irc_conn_register_info *info);

   121

   122

/**

   123

 * @group Simple request functions

   124

 *

   125

 * The error handling of these functions is such that the error return code is can be used or ignored as convenient,

   126

 * as connection-fatal errors will be handled internally.

   127

 *

   128

 * @{

   129

 */

   130

   131

/**

   132

 * Send a generic IRC message

   133

 *

   134

 * @param conn the IRC protocol connection

   135

 * @param line the irc_line protocol line to send

   136

 * @return error code

   137

 */

   138

err_t irc_conn_send (struct irc_conn *conn, const struct irc_line *line);

   139

   140

/**

   141

 * Send a NICK message

   142

 *

   143

 * @param nickname the new nickname to use

   144

 */

   145

err_t irc_conn_NICK (struct irc_conn *conn, const char *nickname);

   146

   147

/*

   148

 * Send a USER message

   149

 *

   150

 * @param username the username to register with, may be replaced with ident reply

   151

 * @param realname the full-name to register with

   152

 */

   153

err_t irc_conn_USER (struct irc_conn *conn, const char *username, const char *realname);

   154

   155

/*

   156

 * Send a PONG message to the given target

   157

 *

   158

 * @param target the PING source, aka. the target to send the PONG reply to

   159

 */

   160

err_t irc_conn_PONG (struct irc_conn *conn, const char *target);

   161

   162

/*

   163

 * Send a JOIN message for the given channel

   164

 *

   165

 * XXX: this doesn't implement the full command options

   166

 *

   167

 * @param channel the full channel name to join

   168

 */

   169

err_t irc_conn_JOIN (struct irc_conn *conn, const char *channel);

   170

   171

// @}

   172

   173

#endif /* IRC_CONN_H */