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

 * Connection state

    23

 */

    24

struct irc_conn {

    25

    /* We are a line-based protocol */

    26

    struct line_proto *lp;

    27

    28

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

    29

    bool registered;

    30

    31

    /* Command handlers */

    32

    STAILQ_HEAD(irc_conn_handlers, irc_cmd_chain) handlers;

    33

};

    34

    35

// XXX: this should probably be slightly reworked

    42

struct irc_conn_config {

    43

    /* Nickname to use on that server */

    44

    const char *nickname;

    45

    46

    /* Username to supply */

    47

    const char *username;

    48

    49

    /* Realname to supply */

    50

    const char *realname;

    51

};

    52

    53

/**

    54

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

    55

 * in \a config will be used to identify with the IRC server.

    56

 *

    57

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

    58

 * via *err.

    59

 *

    60

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

    61

 * @param sock the socket connected to the IRC server

    62

 * @param config the basic information used to register

    63

 * @param err errors are returned via this pointer

    64

 * @return error code

    65

 */

    66

err_t irc_conn_create (struct irc_conn **conn, struct sock_stream *sock, const struct irc_conn_config *config, struct error_info *err);

    67

    68

/**

    69

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

    70

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

    71

 *

    72

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

    73

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

    74

 */

    75

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

    76

    77

/**

    78

 * @group Simple request functions

    79

 *

    80

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

    81

 * as connection-fatal errors will be handled internally.

    82

 *

    83

 * @{

    84

 */

    85

    86

/**

    87

 * Send a generic IRC message

    88

 *

    89

 * @param conn the IRC protocol connection

    90

 * @param line the irc_line protocol line to send

    91

 * @return error code

    92

 */

    93

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

    94

    95

/**

    96

 * Send a NICK message

    97

 *

    98

 * @param nickname the new nickname to use

    99

 */

   100

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

   101

   102

/*

   103

 * Send a USER message

   104

 *

   105

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

   106

 * @param realname the full-name to register with

   107

 */

   108

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

   109

   110

/*

   111

 * Send a PONG message to the given target

   112

 *

   113

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

   114

 */

   115

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

   116

   117

/*

   118

 * Send a JOIN message for the given channel

   119

 *

   120

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

   121

 *

   122

 * @param channel the full channel name to join

   123

 */

   124

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

   125

   126

// @}

   127

   128

#endif /* IRC_CONN_H */