1

#ifndef IRC_CONN_H

     2

#define IRC_CONN_H

     3

     4

/*

     5

 * Per-connection IRC setup and state/protocol handling.

     6

 */

     7

     8

#include "sock.h"

     9

#include "line_proto.h"

    10

#include "irc_line.h"

    11

#include "error.h"

    13

    14

/*

    15

 * A connection to an IRC server.

    16

 */

    17

struct irc_conn {

    18

    /* We are a line-based protocol */

    19

    struct line_proto *lp;

    23

};

    24

    25

// XXX: this should probably be slightly reworked

    26

struct irc_conn_config {

    27

    /* Nickname to use on that server */

    28

    const char *nickname;

    29

    30

    /* Username to supply */

    31

    const char *username;

    32

    33

    /* Realname to supply */

    34

    const char *realname;

    35

};

    36

    37

/*

    38

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

    39

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

    40

 *

    41

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

    42

 * via *err.

    43

 */

    44

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

    45

    46

/**

    47

 * @group Simple request functions

    48

 *

    49

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

    50

 * as connection-fatal errors will be handled internally.

    51

 *

    52

 * @{

    53

 */

    54

    55

/*

    61

 * Send a NICK message

    62

 */

    63

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

    64

    65

/*

    66

 * Send a USER message

    67

 */

    68

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

    69

    70

/*

    71

 * Send a PONG message to the given target

    72

 */

    73

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

    74

    77

#endif /* IRC_CONN_H */