3

     4

/**

     5

 * @file

     6

 *

     7

 * Defines a intermediate-level (as opposed to high-level or low-level) API for connected streams of data, presumeably

     8

 * non-blocking ones.

     9

 */

    10

#include "error.h"

    12

    13

/**

    14

 * Opaque transport state handle.

    15

 *

    16

 * Transports are reliable byte streams, connected with some endpoint over some medium. Common implementations are

    17

 * e.g. TCP, SSL or fifo transports (using the OS file/socket API).

    18

 *

    19

 * Transports can be connected or unconnected. For synchronous opens (e.g. fifo_open_read()), the transport returned

    20

 * will already be connected, meaning that the transport_callbacks::on_connect callback is unused. For async connects

    21

 * such as sock_tcp_connect()/sock_ssl_connect(), the transport returned is *not* connected, and you must wait for

    22

 * transport_callbacks::on_connect to be called before being able to send/recieve data on the transport.

    23

 *

    24

 * Once you have an opened transport, sending and receiving data is simple - just call transport_read()/transport_write().

    25

 * These implement unbuffered I/O, so they may do partial reads/writes. In terms of the system read/write calls, the

    27

 * ERR_WRITE_EOF for transport_write, for whoever knows what that means...). This means that when the underlying

    28

 * transport is unable to fufill the request due to lack of data/buffer space, these can return zero to signifiy

    29

 * something simliar to EAGAIN.

    30

 *

    31

 * The transport API also implements non-blocking/event-based operation (usually on top of libevent), although at a

    32

 * slightly different level than the normal select/poll API. Instead of the user asking the transport to notify for

    33

 * read/write after transport_read/transport_write return zero, the transport will take care of this itself. 

    34

 * 

    35

 * Specifically, the user can supply a mask of events they are currently interested in. By default, this should be the

    36

 * full TRANSPORT_READ | TRANSPORT_WRITE, as the transport will take care of managing events by itself. If you wish to

    37

 * e.g. throttle read/write, you may set a different event mask using transport_events(), which will prevent the

    38

 * relevant callback from being triggered.

    39

 *

    40

 * For reads, the transport maintains a persistent read event, and will always call on_read when data is available on

    41

 * the socket (i.e. normal select() semantics). If masked out using transport_events(), there should be no event

    42

 * activity on the transport (i.e. the fd read event is removed).

    43

 *

    44

 * For writes, the transport maintains a write event that is disabled by default. If transport_write() returns zero, it will

    45

 * become enabled *once*, and consequently trigger transport_callbacks::on_write *once*, after which you must call

    46

 * transport_write() to possibly enable it again. If masked out using transport_events(), transport_write() will not

    47

 * enable the write event, and any pending write event is cancelled. If masked back in using transport_events(), the

    48

 * write event will *not* be registered, so if you have pending data, do a transport_write() after enabling

    49

 * TRANSPORT_WRITE.

    50

 *

    51

 * Note that transport_write() returning fewer bytes than given will *not* enable the write event! You must call

    52

 * transport_write() until you have either written all of your data, or it returns zero!

    53

 */

    54

struct transport;

    55

    56

/**

    57

 * @see transport

    58

 */

    59

typedef struct transport transport_t;

    60

    61

/**

    74

 * User callbacks for transports

    75

 *

    76

 * @see transport

    77

 */

    78

struct transport_callbacks {

    79

    /**

    80

     * The transport is now connected

    81

     */

    82

    void (*on_connect) (transport_t *transport, void *arg);

    83

    84

    /**

    85

     * Data is now available for reading from the transport

    86

     */

    87

    void (*on_read) (transport_t *transport, void *arg);

    88

    89

    /**

    90

     * The transport has become writeable

    91

     */

    92

    void (*on_write) (transport_t *transport, void *arg);

    93

    94

    /**

    95

     * An asynchronous error has occured. This is only called for errors that occur while being called directly from

    96

     * the underlying event loop, and never from inside an API function.

    97

     *

    98

     * You must call transport_destroy to release the transport.

    99

     */

   100

    void (*on_error) (transport_t *transport, const error_t *err, void *arg);

   101

};

   102

   103

/**

   104

 * Bitmask of available events

   105

 *

   106

 * @see transport

   107

 */

   108

enum transport_event {

   109

    TRANSPORT_READ  = 0x01,

   110

    TRANSPORT_WRITE = 0x02,

   111

};

   112

   113

/**

   114

 * User info required to build a transport

   115

 *

   116

 * @see transport

   117

 */

   118

struct transport_info {

   119

    /** The callbacks table */

   120

    const struct transport_callbacks *cb_tbl;

   121

   122

    /** The callback context argument */

   123

    void *cb_arg;

   124

   125

    /** Initial event mask using transport_event flags */

   126

    short ev_mask;

   127

};

   128

   129

/**

   130

 * Read a series of bytes from the transport into the given \a buf (up to \a len bytes). If succesfull, this returns

   131

 * the number of bytes read (which will be less than or equal to \a len). If the transport is nonblocking, and there is

   132

 * no data available, this returns zero, and need not be called again until transport_callbacks::on_read is invoked.

   133

 *

   134

 * On errors, this returns the negative error code, and more info via \a err. Note that as opposed to read(2), EOF is

   135

 * handled as an error, returning ERR_EOF.

   136

 *

   137

 * @param transport the transport state

   138

 * @param buf the buffer to read the bytes into

   139

 * @param len the number of bytes to read into the buffer

   140

 * @param err returned error info

   141

 * @return bytes read, zero if none available, -err_t

   142

 */

   143

int transport_read (transport_t *transport, void *buf, size_t len, error_t *err);

   144

   145

/**

   146

 * Write a series of bytes from the given \a buf (containing \a len bytes) to the transport. If succesfull, this

   147

 * returns the number of bytes written (which may be less than \a len). If the transport is nonblocking, and the

   148

 * operation would have blocked, no data will be written, and zero is returned; in this case, the transport's write

   149

 * event is enabled (unless TRANSPORT_WRITE is masked out).

   150

 *

   151

 * On errors, this returns the negative error code, along with extended info via \a err.

   152

 *

   153

 * @param transport the transport state

   154

 * @param buf the buffer to write the bytes from

   155

 * @param len number of bytes to write

   156

 * @param err returned error info

   157

 * @return bytes written, zero if would have blocked, -err_t

   158

 */

   159

int transport_write (transport_t *transport, const void *buf, size_t len, error_t *err);

   160

   161

/**

   162

 * Change the mask of enabled events.

   163

 */

   164

err_t transport_events (transport_t *transport, short mask);

   165

   166

/**

   167

 * Install a new set of callback handlers, replacing the old ones.

   168

 */

   169

void transport_set_callbacks (transport_t *transport, const struct transport_callbacks *cb_tbl, void *cb_arg);

   170

   171

/**

   172

 * Close and destroy the transport immediately, severing any established connection rudely.

   173

 *

   174

 * This will release all resources associated with the transport, including the transport itself, which must not be

   175

 * used anymore.

   176

 */

   177

void transport_destroy (transport_t *transport);

   178

   179

#endif