include_HEADERS = src/client/distren.h

lib_LTLIBRARIES = libdistren.la

pkglib_LTLIBRARIES = libdistrencommon.la

# libdistrencommon.la:

libdistrencommon_la_SOURCES = src/common/asprintf.c src/common/asprintf.h \

	src/common/execio.c src/common/execio.h \

	src/common/misc.c src/common/misc.h \

	src/common/multiio.c src/common/multiio.h \

	src/common/options.c src/common/options.h \

	src/common/protocol.c src/common/protocol.h \

	src/common/remoteio.h \

	src/common/remoteio.c src/common/libremoteio.h \

	src/common/request.c src/common/request.h

#see http://sources.redhat.com/autobook/autobook/autobook_91.html

# either increase the revision number or the interface number each release!

libdistrencommon_la_LDFLAGS = $(AM_LDFLAGS) -version-info 0:0:0

#library client

libdistren_la_SOURCES = \

	src/client/libdistren.c src/client/libdistren.h \

	src/client/libdistren_config.c \

libdistren_la_LIBADD = libdistrencommon.la

#CLI client.

distren_SOURCES = \

	src/client/distren.c

distren_LDADD = libdistrencommon.la libdistren.la

# shared server sources:

SERVER_SOURCES = \

	src/server/slavefuncs.c	src/server/slavefuncs.h \

	src/server/distrenjob.c	src/server/distrenjob.h

# distrend:

distrend_CFLAGS = $(AM_CFLAGS) $(MYSQL_CFLAGS)

distrend_LDFLAGS = $(AM_LDFLAGS) $(MYSQL_LDFLAGS)

distrend_SOURCES = $(SERVER_SOURCES) \

	src/server/distrend.c	src/server/distrend.h \

	src/server/listen.h	src/server/listen.c \

	src/server/mysql.h	src/server/mysql.c \

	src/server/tabletennis.c	src/server/tabletennis.h \

	src/server/user_mgr.c	src/server/user_mgr.h

distrend_LDADD = libdistrencommon.la

# distrenslave:

distrenslave_SOURCES = $(SERVER_SOURCES) \

- job: Represents a collection of renderings that must be unbundled, rendered, and bundled together again.

  - job identification: A server shall internally assign numeric job identifiers. It must only

      make sure that it never issues the same numeric job identifier to multiple jobs. To allow

      multiple servers to share jobs with eachother (which is the the whole point of distren),

      a job shall be refered to by prefixing the job a server identification. For example,

      distren://<servername>/<jobid>

  - job packaging: Currently, the most creative way of dealing with jobs I have at the moment is

      storing all of the data necessary to render the job in a tarball. This tarball can be

      treated as a directory of a normal filesystem. A job's directory would contain at least one

      file called ``distrenjob.xml'' which provides information necessary to render the job. This

      will be an XML file rather than a rigidly defined binary format because XML supports

      arbitrary data storage out of the box. This should allow different rendering backends to

      store the extra information that is specific to that backend.

  - post-render rebundling: Again, to make things simpler, the server where a job is rendered

      shall be responsible for collecting the individual completed frames and collecting them

      into a tarball. This tarball may be called for using a client. This tarball is a bundle

      of completed frames and will exclude the seed tarball.

- frame: Represents a distinct, and hopefully small, unit of work that a renderer backend can perform.

  - frame identification: Like a job numeral is useless without a qualifying servername, a 

      frame's identification number would be useless without an accompanying job identifier. The

      numeric value of a frame identification value must be unique to that job. There are no

      restrictions of ordering of frame numbers except that they are not to be negative. There

      need be no sequencing of frame numbers either. Thus, a frame identification URL would look

  - size: A frame hopefully represents a smaller unit of work in terms of the rendering

      back-end's capabilities. For example, POV-Ray's CLI can initiate and carry out the rendering

      of an entire animation. But distren would hopefully be able to provide a clean method for

      rendering each individual frame and bringing the resulting set of files back to the user

      in a much shorter time than a single computer could on its own. Many smaller and distinct

      is key to a project being benefited by distren.

  - dependencies: One cannot escape from frame's completion potentially requiring the completion

      of another. Thus, each frame's record must explicitly list the URLs of frames that need to

      be completed prior to the said frame. For a server to complete a frame dependent on other

      frames, those other frames must be transfered to the first server and made available.

  - packaging: To render a single frame and move it about somewhere is normally trivial. However,

      one frame or rendering unit of a given backend may produce multiple files. For this reason

      and for further uniformity and simplification, the data files representing one frame shall

      be transferred using the tarball format.

- client: A distren client is able to submit, query state of, and download completed frames of

      jobs registered in a server.

  - servers: A server, though having many more functions, shall be able to also perform the list

      of actions a client may perform.

	  printinfo = 1;

	  break;

	}

    }

     // give this error after the general arguments parsing so that

     // the general help from options_init can have effect

  if(!username || !password)

    {

      fprintf(stderr, "Username and password must be specified:\n");

      if(!username)

	fprintf(stderr, "\tyou did not specify a username\n");

      if(!password)

	fprintf(stderr, "\tyou did not specify a password\n");

      return 1;

    }

  if(dologin)

    {

      fprintf(stderr, "Trying username and password on server...");

      fprintf(stderr, "STUB\n");

      lazy = 0;

    }

    {

      fprintf(stderr, "error initializing the distren handle\n");

      return 1;

    }

  if(input)

    {

      if(distren_submit_file(distren, &distren_job, input))

	{

	  fprintf(stderr, "error submitting file\n");

	  return 1;

	}

      if(distren_job_geturi(distren_job, &joburi))

	{

	  fprintf(stderr, "error retrieving joburi\n");

	  return 1;

	}

      lazy = 0;

      fprintf(stdout, "joburi: %s\n", joburi);

    }

  if(output)

  it under the terms of the GNU Affero General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License

  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef DISTREN_H

#define DISTREN_H 1

/*

  Public API for DistRen

 */

#include <stddef.h> /* size_t */

typedef struct distren *distren_t;

typedef struct distren_job *distren_job_t;

/**

int distren_init(distren_t *handle);

/**

 Submits a file to distren.

 @param job must not refer to a valid job.

 @TODO create a stream-based interface

*/

int distren_submit_file(distren_t handle, distren_job_t *job, const char *filename);

/**

   Retrieve a job-ID that can be used to refer to the job after the client's process has recycled. Currently, this will be the only way to retrieve a job handle (a distren_job_t) and, consequently, the only way to retrieve a finished render.

   A job ID is representable using a character string. Hopefully, they will be kept at a reasonably small length. It should be made up of alphanumeric characters so as to be useful in most situations. 

   @param jobid This will be set to a string allocated by the specified malloc implementation

   @param job The distren_job_t from which to retrieve a jobid

*/

int distren_job_geturi(distren_job_t job, char **joburi);

/**

   Retrieves a tarball of a rendering's result.

   @param outfile Filename to save the result to

 */

int distren_job_retrieve_file(distren_job_t job, const char *outfile);

/*

 TODO: extraction of a job-ID, retrieving job handle by job-ID, getting information

 for a job handle, retrieving results of a job, callbacks for progress (i.e., job_is_finished callback)

 -- threads? -- noooo!

*/

/**

 Destroys and frees a job handle

*/

int distren_job_free(distren_job_t job);

/**

int distren_free(distren_t handle);

#endif

/*

  Copyright 2010 Nathan Phillip Brink, Ethan Zonca, Matt Orlando

  This file is a part of DistRen.

  DistRen is free software: you can redistribute it and/or modify

  it under the terms of the GNU Affero General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License

  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/

/*

  Implementation of distren_* functions from distren.h excluding distren_job_* functions.

 */

#include "common/config.h"

#include "libdistren.h"

#include <stdio.h>

#include <stdlib.h>

{

  if(!*handle)

    return 1;

  /* now the environment is ready for general use */

  if(_distren_getoptions(*handle))

    {

      fprintf(stderr, "error getting configuration\n");

      distren_free(*handle);

      return 1;

    }

  return 0;

}

/**

 */

int distren_submit_file(distren_t handle, distren_job_t *job, const char *filename)

{

  return 1;

}

int distren_free(distren_t handle)

{

  free(handle);

  return 0;

}

  DistRen is free software: you can redistribute it and/or modify

  it under the terms of the GNU Affero General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License

  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef LIBDISTREN_H_

#define LIBDISTREN_H_ 1

/*

  Private definitions for libdistren.

 */

#include "distren.h"

#include "common/multiio.h"

struct distren

{

  char *server;

  multiio_context_t multiio;

};

struct distren_job

{

};

/*

  functions

*/

/**

   Avoid poluting the public namespace until we fix visibility.

 */

#define _malloc _distren_malloc

/**

   All of libdistren should use this rather than malloc.h's malloc.

 */

void *_malloc(distren_t distren, size_t size);

/**

   Avoid poluting the public namespace until we fix visibility.

 */

#define _free _distren_free

/**

   All of libdisren should use this instead of malloc.h's free()

*/

void _free(distren_t distren, void *tofree);

/**

 * Sets up the distren handle with information garnered from

 * configuration files, etc. Uses the environment variable

 * DISTREN_CONFIG or the built-in default config file location.

 *

 * Also initializes multiio.

 */

int _distren_getoptions(distren_t handle);

/**

 * Unsets-up the distren handle with options loadable from a config file.

 *

 * Also unloads multiio.

 */

int _distren_loseoptions(distren_t handle);

#endif

      fputs("\n\tmagic=`", stderr);

      debugtmp = DISTREN_REQUEST_MAGIC;

      for(counter = 0; counter < sizeof(uint32_t); counter ++)

	putc(((char *)&debugtmp)[counter], stderr);

      fputs("'\n\t`", stderr);

      for(counter = 0; counter < sizeof(struct distren_request); counter ++)

	putc(((char *)data)[counter], stderr);

      fputs("'\n", stderr);

#endif

      return 1;

    }

  newreq = malloc(sizeof(struct distren_request));

  if(!newreq)

    {

      fprintf(stderr, "OOM\n");

      return 1;

    }

  memcpy(newreq, data, sizeof(struct distren_request));

  (*req) = newreq;

  return 0;

}

int distren_request_free(struct distren_request *req)

{

  free(req);

  return 0;

}

  This file is a part of DistRen.

  DistRen is free software: you can redistribute it and/or modify

  it under the terms of the GNU Affero General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License

  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef DISTREN_PROTOCOL_H

#define DISTREN_PROTOCOL_H

#include <stddef.h>

#include <stdint.h>

/**

 */

#define DISTREN_SERVERTYPE_SUBMIT (0x1)

#define DISTREN_SERVERTYPE_DISTRIBUTE (0x2)

#define DISTREN_SERVERTYPE_RENDER (0x4)

/**

 */

/**

 */

enum distren_request_type

  {

    /**

    */

    DISTREN_REQUEST_VERSION = 1,

    DISTREN_REQUEST_PING = 2,

    DISTREN_REQUEST_PONG = 3,

    /**

     */

    DISTREN_REQUEST_DISCONNECT = 4,

    /**

    DISTREN_REQUEST_SUBMIT = 5,

    /**

     */

    /**

     */