1

#ifndef SOCK_INTERNAL_H

     2

#define SOCK_INTERNAL_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * internal sock_* interface

     8

 */

     9

#include "sock.h"

    10

    11

/**

    12

 * General state for all sock_stream's

    13

 */

    14

struct sock_stream_ctx {

    15

    /** libevent core */

    16

    struct event_base *ev_base;

    17

    18

};

    19

    20

/**

    21

 * Global sock_stream_ctx used for sock_init() and all sock_stream's

    22

 */

    23

extern struct sock_stream_ctx _sock_stream_ctx;

    24

    25

/**

    26

 * Socket implementation type methods

    27

 */

    28

struct sock_stream_methods {

    29

    /** As read(2) */

    30

    err_t (*read) (struct sock_stream *sock, void *buf, size_t *len);

    31

    32

    /** As write(2) */

    33

    err_t (*write) (struct sock_stream *sock, const void *buf, size_t *len);

    34

    35

    /** Initialize events. cb_info/cb_arg are already updated */

    36

    err_t (*event_init) (struct sock_stream *sock);

    37

    38

    /** Enable events as specified */

    39

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

    40

    41

    /** Release all resources and free the sock_stream */

    42

    void (*release) (struct sock_stream *sock);

    43

};

    44

    45

/**

    46

 * The base type struct, which defines the method table.

    47

 */

    48

struct sock_stream_type {

    49

    /** Method table */

    50

    struct sock_stream_methods methods;

    51

};

    52

    53

/**

    54

 * The base sock_stream type, as used by the sock_stream_* functions.

    55

 *

    56

 * The specific implementations should embed this at the start of their type-specific struct, and then cast around

    57

 * as appropriate.

    58

 */

    59

struct sock_stream {

    60

    /** The sock_stream_type for this socket */

    61

    struct sock_stream_type *type;

    62

    63

    /** Last error info, XXX: remove this */

    64

    struct error_info err;

    65

    66

    /** Callbacks */

    67

    const struct sock_stream_callbacks *cb_info;

    68

    69

    /** Callback arg */

    70

    void *cb_arg;

    71

    72

    /** Connection callback function */

    73

    sock_stream_connect_cb conn_cb_func;

    74

    75

    /** Connection callback context argument */

    76

    void *conn_cb_arg;

    77

};

    78

    79

/**

    80

 * Convert a `struct sock_stream*` to the given type.

    81

 */

    82

#define SOCK_FROM_BASE(sock, type) ((type*) sock)

    83

    84

/**

    85

 * Get a pointer to the sock_stream's error_info field.

    86

 */

    87

#define SOCK_ERR(sock) (&(sock)->err)

    88

    89

/**

    90

 * Initialize a sock_stream with the given sock_stream_type.

    91

 *

    92

 * The sock_stream should be initialized to zero. It is a bug to call this twice.

    93

 *

    94

 * @param sock the new sock_stream

    95

 * @param type the sock_stream_type defining the implementation used

    96

 */

    97

void sock_stream_init (struct sock_stream *sock, struct sock_stream_type *type);

    98

    99

/**

   100

 * Invoke the appropriate callbacks for the given EV_* bitmask.

   101

 *

   102

 * @param sock the sock_stream

   103

 * @param what combination of EV_* bits describing what callbacks to invoke

   104

 */

   105

void sock_stream_invoke_callbacks (struct sock_stream *sock, short what);

   106

   107

#endif /* SOCK_INTERNAL_H */