render_remote.h
author Tero Marttila <terom@fixme.fi>
Thu, 05 Jun 2008 22:53:47 +0300
changeset 6 4252c27f2b72
parent 5 d4263f1f5b55
child 7 446c0b816b91
permissions -rw-r--r--
flow control for web_main.c

committer: Tero Marttila <terom@fixme.fi>
2
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
#ifndef RENDER_REMOTE_H
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
#define RENDER_REMOTE_H
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
4
49edbdf9ebe7 updated code to use libevent svn (with custom modifications, need to create a git repo for that)
Tero Marttila <terom@fixme.fi>
parents: 3
diff changeset
     4
#include <event2/util.h>
49edbdf9ebe7 updated code to use libevent svn (with custom modifications, need to create a git repo for that)
Tero Marttila <terom@fixme.fi>
parents: 3
diff changeset
     5
#include <event2/buffer.h>
2
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
#include "render.h"
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
/*
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
 * Execute a render_t operation on a remote render_node
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
 */
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
#define RENDER_PORT 6159
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    16
struct remote_render_ctx;
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    17
2
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
/*
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    19
 * Execute the given render operation on the render_node at the given remote address.
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    20
 *
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    21
 * The various callback functions must all be provided.
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    22
 *
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    23
 * cb_sent will be invoked after the request has succesfully been written, and before cb_data is called.
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    24
 * cb_data is called whenever new data has been received. See also, render_remote_set_chunk_size
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    25
 * cb_done is called when all the data has been passed to cb_data
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    26
 * cb_fail is called when an error is encountered. This can (and will) happen at any time!
2
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    27
 */
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    28
struct remote_render_ctx *render_remote (
2
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    29
        render_t *render_ctx,               // what to render
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
        struct sockaddr_storage *remote,    // what render node to use
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
        void (*cb_sent)(void *arg),
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
        void (*cb_data)(struct evbuffer *buf, void *arg),
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
        void (*cb_done)(void *arg),
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
        void (*cb_fail)(void *arg),
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
        void *cb_arg;
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
);
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    38
/*
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    39
 * Cancel the given request. No more callbacks will be called, buffered data is discarded and the remote render process will cancel asap.
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    40
 */
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    41
void render_remote_cancel (struct remote_render_ctx *ctx);
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    42
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    43
/*
6
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    44
 * Controls the behaviour of when cb_data is called, and how remote data is read in.
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    45
 *
6
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    46
 * recv_threshold, sets a threshold for calling cb_data - cb_data will only be called
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    47
 * if the buffer contains at least recv_threshold, bytes. Note that cb_data is only
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    48
 * ever called when new data has been receieved from the remote end - never
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    49
 * otherwise. If cb_data doesn't drain the buffer, cb_data will be called again
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    50
 * once more data has been received from the remote end.
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    51
 *
6
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    52
 * overflow_size can be used to control the amount of unread data in cb_data. If 
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    53
 * the buffer contains more than recv_threshold + unread_buffer bytes, we will stop
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    54
 * accepting bytes from the remote end, and cb_data will not be called any more.
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    55
 *
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    56
 * Only call this once cb_sent has fired
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    57
 */
6
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    58
int render_remote_set_recv (struct remote_render_ctx *ctx, size_t recv_threshold, size_t unread_buffer);
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    59
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    60
/*
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    61
 * Call cb_data with the current set of buffered input data immediately,
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    62
 * regardless of whether or not the buffer contains any data, or any new
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    63
 * data has been received.
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    64
 *
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    65
 * Only call this after cb_sent and before cb_done/cb_fail.
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    66
 */
4252c27f2b72 flow control for web_main.c
Tero Marttila <terom@fixme.fi>
parents: 5
diff changeset
    67
int render_remote_shake (struct remote_render_ctx *ctx);
3
675be0a45157 working chunked-streaming of remote-rendered mandelbrots in web_main, next step will be flow control. Remote rendering doesn't compile in render_node.
Tero Marttila <terom@fixme.fi>
parents: 2
diff changeset
    68
2
69f8c0acaac7 working web_main that uses render_remote
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    69
#endif /* RENDER_REMOTE_H */