1

#ifndef SOCK_H

     2

#define SOCK_H

     3

     4

/*

     5

 * Low-level socket-related functions

     6

 */

     7

#include "error.h"

     8

#include <sys/types.h>

     9

#include <event2/event.h>

    10

    11

/*

    12

 * The generic socket handle

    13

 */

    14

struct sock_stream;

    15

    16

/*

    17

 * Async callbacks for socket operation

    18

 */

    19

struct sock_stream_callbacks {

    20

    /* Sockeet is readable */

    21

    void (*on_read)(struct sock_stream *sock, void *arg);

    22

    23

    /* Socket is writeable */

    24

    void (*on_write)(struct sock_stream *sock, void *arg);

    25

};

    26

    27

/*

    28

 * Initialize the socket module's global state. Call this before calling any other sock_* functions.

    29

 *

    30

 * The given \a ev_base is the libevent base to use for nonblocking operation.

    31

 */

    32

err_t sock_init (struct event_base *ev_base, struct error_info *err);

    33

    34

/*

    35

 * A simple blocking TCP connect to the given host/service, using getaddrinfo. The connected socket is returned via

    36

 * *sock_ptr. In case of errors, additional error information is stored in *err.

    37

 *

    38

 * @return zero on success, nonzero on error

    39

 *

    40

 * XXX: blocking

    41

 */

    42

err_t sock_tcp_connect (struct sock_stream **sock_ptr, const char *host, const char *service, struct error_info *err);

    43

    44

/*

    45

 * A simple blocking SSL connect to the given host/service. The connected/handshake'd SSL socket is returned via

    46

 * *sock_ptr. In case of errors, additional error information is stored in *err.

    47

 *

    48

 * XXX: blocking

    49

 * XXX: doesn't do any certificate verification.

    50

 */

    52

    53

/*

    54

 * The generic read/write API for stream sockets. These are mostly identical to the equivalent read/write syscalls, but

    55

 * the handling of EOF and EAGAIN is different. Normally, these return the (positive) number of bytes written. For

    56

 * EAGAIN, these return zero. For EOF, these return -ERR_READ_EOF/ERR_WRITE_EOF. Otherwise, these return the -ERR_*

    57

 * code.

    58

 */

    59

int sock_stream_read (struct sock_stream *sock, void *buf, size_t len);

    60

int sock_stream_write (struct sock_stream *sock, const void *buf, size_t len);

    61

    62

/*

    63

 * Initialize event-based operation for this sock_stream. This will set the stream into nonblocking mode, and the given

    64

 * callbacks will be fired once enabled using sock_stream_event_enable().

    65

 *

    66

 * Note that the callbacks struct isn't copied - it's used as-is-given.

    67

 */

    68

err_t sock_stream_event_init (struct sock_stream *sock, const struct sock_stream_callbacks *callbacks, void *arg);

    69

    70

/*

    71

 * Enable the events for this sock, as set up earlier with event_init. Mask should contain EV_READ/EV_WRITE.

    72

 *

    73

 * The implementation of this is slightly hazy for complex protocols; this should only be used to map from

    74

 * sock_stream_read/write to the corresponding sock_stream_callback. That is, if sock_stream_read returns zero, then

    75

 * call event_enable(EV_READ), wherepon on_read will later be called.

    76

 */

    77

err_t sock_stream_event_enable (struct sock_stream *sock, short mask);

    78

    79

/**

    80

 * Get current error_info for \a sock.

    81

 */

    82

const struct error_info* sock_stream_error (struct sock_stream *sock);

    83

    84

#endif