costin 01/11/20 16:15:16
Modified: jk/native/common jk_worker.c jk_worker.h jk_service.h
Added: jk/native/common jk_endpoint.h
Log:
Moved the worker declaration in jk_worker.h, the endpoint in jk_endpoint.h.
This is supposed to make things easier to find and more consistent. Each
'type' is defined in jk_type.h.
jk_worker_env is a problem - I think this ( and all other 'global' jk properties )
belong in jk_env.h.
Another issue is jk_util.c - which contains the logger and some worker-related
property access methods.
All this is 'cosmetic', the behavior of the code is the same.
Revision Changes Path
1.10 +2 -16 jakarta-tomcat-connectors/jk/native/common/jk_worker.c
Index: jk_worker.c
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/native/common/jk_worker.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- jk_worker.c 2001/11/16 22:59:06 1.9
+++ jk_worker.c 2001/11/21 00:15:15 1.10
@@ -60,7 +60,7 @@
* Description: Workers controller *
* Author: Gal Shachor <[EMAIL PROTECTED]> *
* Author: Henri Gomez <[EMAIL PROTECTED]> *
- * Version: $Revision: 1.9 $ *
+ * Version: $Revision: 1.10 $ *
***************************************************************************/
/* #define _PLACE_WORKER_LIST_HERE */
@@ -191,7 +191,7 @@
}
*rc = w;
- jk_log(l, JK_LOG_DEBUG, "wc_create_worker, done\n");
+ jk_log(l, JK_LOG_DEBUG, "wc_create_worker, done\n");
return JK_TRUE;
}
@@ -257,17 +257,3 @@
jk_log(l, JK_LOG_DEBUG, "build_worker_map, done\n");
return JK_TRUE;
}
-
-/* static worker_factory get_factory_for(char *type) */
-/* { */
-/* worker_factory_record_t *factory = &worker_factories[0]; */
-/* while(factory->name) { */
-/* if(0 == strcmp(factory->name, type)) { */
-/* return factory->fac; */
-/* } */
-
-/* factory ++; */
-/* } */
-
-/* return NULL; */
-/* } */
1.6 +125 -3 jakarta-tomcat-connectors/jk/native/common/jk_worker.h
Index: jk_worker.h
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/native/common/jk_worker.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- jk_worker.h 2001/06/18 14:16:16 1.5
+++ jk_worker.h 2001/11/21 00:15:15 1.6
@@ -58,7 +58,7 @@
/***************************************************************************
* Description: Workers controller header file *
* Author: Gal Shachor <[EMAIL PROTECTED]> *
- * Version: $Revision: 1.5 $ *
+ * Version: $Revision: 1.6 $ *
***************************************************************************/
#ifndef JK_WORKER_H
@@ -66,6 +66,7 @@
#include "jk_logger.h"
#include "jk_service.h"
+#include "jk_endpoint.h"
#include "jk_map.h"
#include "jk_uri_worker_map.h"
@@ -73,8 +74,129 @@
extern "C" {
#endif /* __cplusplus */
+struct jk_worker;
+struct jk_endpoint;
+struct jk_worker_env;
+typedef struct jk_worker jk_worker_t;
+
+/*
+ * The worker 'class', which represents something to which the web server
+ * can delegate requests.
+ *
+ * This can mean communicating with a particular servlet engine instance,
+ * using a particular protocol. A single web server instance may have
+ * multiple workers communicating with a single servlet engine (it could be
+ * using ajp12 for some requests and ajp13/ajp14 for others). Or, a single web
+ * server instance could have multiple workers communicating with different
+ * servlet engines using the same protocol (it could be load balancing
+ * among many engines, using ajp13/ajp14 for all communication).
+ *
+ * There is also a load balancing worker (jk_lb_worker.c), which itself
+ * manages a group of workers.
+ *
+ * Web servers are configured to forward requests to a given worker. To
+ * handle those requests, the worker's get_endpoint method is called, and
+ * then the service() method of that endpoint is called.
+ *
+ * As with all the core jk classes, this is essentially an abstract base
+ * class which is implemented/extended by classes which are specific to a
+ * particular protocol (or request-handling system). By using an abstract
+ * base class in this manner, plugins can be written for different servers
+ * (e.g. IIS, Apache) without the plugins having to worry about which
+ * protocol they are talking.
+ *
+ * This particular OO-in-C system uses a 'worker_private' pointer to
+ * point to the protocol-specific data/functions. So in the subclasses, the
+ * methods do most of their work by getting their hands on the
+ * worker_private pointer and then using that to get at the functions for
+ * their protocol.
+ *
+ * Try imagining this as a 'public abstract class', and the
+ * worker_private pointer as a sort of extra 'this' reference. Or
+ * imagine that you are seeing the internal vtables of your favorite OO
+ * language. Whatever works for you.
+ *
+ * See jk_ajp14_worker.c, jk_ajp13_worker.c and jk_ajp12_worker.c for examples.
+ */
+struct jk_worker {
+
+ /*
+ * A 'this' pointer which is used by the subclasses of this class to
+ * point to data/functions which are specific to a given protocol
+ * (e.g. ajp12 or ajp13 or ajp14).
+ */
+ void *worker_private;
+
+ /* XXX Add name and all other common properties !!!
+ */
+
+ /** Communication channle used by the worker
+ */
+ struct jk_channel *channel;
+
+ /*
+ * For all of the below (except destroy), the first argument is
+ * essentially a 'this' pointer.
+ */
+
+ /*
+ * Given a worker which is in the process of being created, and a list
+ * of configuration options (or 'properties'), check to see if it the
+ * options are. This will always be called before the init() method.
+ * The init/validate distinction is a bit hazy to me.
+ * See jk_ajp13_worker.c/jk_ajp14_worker.c and jk_worker.c->wc_create_worker()
+ */
+ int (JK_METHOD *validate)(jk_worker_t *w,
+ jk_map_t *props,
+ struct jk_worker_env *we,
+ jk_logger_t *l);
+
+ /*
+ * Do whatever initialization needs to be done to start this worker up.
+ * Configuration options are passed in via the props parameter.
+ */
+ int (JK_METHOD *init)(jk_worker_t *w,
+ jk_map_t *props,
+ struct jk_worker_env *we,
+ jk_logger_t *l);
+
+
+ /*
+ * Obtain an endpoint to service a particular request. A pointer to
+ * the endpoint is stored in pend.
+ */
+ int (JK_METHOD *get_endpoint)(jk_worker_t *w,
+ struct jk_endpoint **pend,
+ jk_logger_t *l);
+
+ /*
+ * Shutdown this worker. The first argument is not a 'this' pointer,
+ * but rather a pointer to 'this', so that the object can be free'd (I
+ * think -- though that doesn't seem to be happening. Hmmm).
+ */
+ int (JK_METHOD *destroy)(jk_worker_t **w,
+ jk_logger_t *l);
+};
+
+/*
+ * Essentially, an abstract base class (or factory class) with a single
+ * method -- think of it as createWorker() or the Factory Method Design
+ * Pattern. There is a different worker_factory function for each of the
+ * different types of workers. The set of all these functions is created
+ * at startup from the list in jk_worker_list.h, and then the correct one
+ * is chosen in jk_worker.c->wc_create_worker(). See jk_worker.c and
+ * jk_ajp13_worker.c/jk_ajp14_worker.c for examples.
+ *
+ * This allows new workers to be written without modifing the plugin code
+ * for the various web servers (since the only link is through
+ * jk_worker_list.h).
+ */
+typedef int (JK_METHOD *worker_factory)(jk_worker_t **w,
+ const char *name,
+ jk_logger_t *l);
+
int wc_open(jk_map_t *init_data,
- jk_worker_env_t *we,
+ struct jk_worker_env *we,
jk_logger_t *l);
void wc_close(jk_logger_t *l);
@@ -85,7 +207,7 @@
int wc_create_worker(const char *name,
jk_map_t *init_data,
jk_worker_t **rc,
- jk_worker_env_t *we,
+ struct jk_worker_env *we,
jk_logger_t *l);
1.11 +3 -186 jakarta-tomcat-connectors/jk/native/common/jk_service.h
Index: jk_service.h
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/native/common/jk_service.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- jk_service.h 2001/11/16 22:43:18 1.10
+++ jk_service.h 2001/11/21 00:15:15 1.11
@@ -63,7 +63,7 @@
* Author: Gal Shachor <[EMAIL PROTECTED]> *
* Author: Dan Milstein <[EMAIL PROTECTED]> *
* Author: Henri Gomez <[EMAIL PROTECTED]> *
- * Version: $Revision: 1.10 $ *
+ * Version: $Revision: 1.11 $ *
***************************************************************************/
#ifndef JK_SERVICE_H
@@ -74,6 +74,8 @@
#include "jk_logger.h"
#include "jk_pool.h"
#include "jk_uri_worker_map.h"
+#include "jk_worker.h"
+#include "jk_endpoint.h"
#ifdef __cplusplus
extern "C" {
@@ -106,8 +108,6 @@
struct jk_worker;
struct jk_channel;
typedef struct jk_ws_service jk_ws_service_t;
-typedef struct jk_endpoint jk_endpoint_t;
-typedef struct jk_worker jk_worker_t;
/*
* The web server service 'class'. An instance of this class is created
@@ -263,189 +263,6 @@
const void *buffer,
unsigned len);
};
-
-/*
- * The endpoint 'class', which represents one end of a connection to the
- * servlet engine. Basically, supports nothing other than forwarding the
- * request to the servlet engine. Endpoints can be persistent (as with
- * ajp13/ajp14, where a single connection is reused many times), or can last for a
- * single request (as with ajp12, where a new connection is created for
- * every request).
- *
- * An endpoint for a given protocol is obtained by the web server plugin
- * from a worker object for that protocol. See below for details.
- *
- * As with all the core jk classes, this is essentially an abstract base
- * class which is implemented/extended by classes which are specific to a
- * particular protocol. By using an abstract base class in this manner,
- * plugins can be written for different servers (e.g. IIS, Apache) without
- * the plugins having to worry about which protocol they are talking.
- *
- * This particular OO-in-C system uses a 'endpoint_private' pointer to
- * point to the protocol-specific data/functions. So in the subclasses, the
- * methods do most of their work by getting their hands on the
- * endpoint_private pointer and then using that to get at the functions for
- * their protocol.
- *
- * Try imagining this as a 'public abstract class', and the
- * endpoint_private pointer as a sort of extra 'this' reference. Or
- * imagine that you are seeing the internal vtables of your favorite OO
- * language. Whatever works for you.
- *
- * See jk_ajp13_worker.c/jk_ajp14_worker.c and jk_ajp12_worker.c for examples.
- */
-struct jk_endpoint {
-
- /*
- * A 'this' pointer which is used by the subclasses of this class to
- * point to data/functions which are specific to a given protocol
- * (e.g. ajp12 or ajp13 or ajp14).
- */
- void *endpoint_private;
-
- /** Data specific to a channel connection
- */
- void *channelData;
-
- /*
- * Forward a request to the servlet engine. The request is described
- * by the jk_ws_service_t object. I'm not sure exactly how
- * is_recoverable_error is being used.
- */
- int (JK_METHOD *service)(jk_endpoint_t *e,
- jk_ws_service_t *s,
- jk_logger_t *l,
- int *is_recoverable_error);
-
- /*
- * Called when this particular endpoint has finished processing a
- * request. For some protocols (e.g. ajp12), this frees the memory
- * associated with the endpoint. For others (e.g. ajp13/ajp14), this can
- * return the endpoint to a cache of already opened endpoints.
- *
- * Note that the first argument is *not* a 'this' pointer, but is
- * rather a pointer to a 'this' pointer. This is necessary, because
- * we may need to free this object.
- */
- int (JK_METHOD *done)(jk_endpoint_t **p,
- jk_logger_t *l);
-};
-
-/*
- * The worker 'class', which represents something to which the web server
- * can delegate requests.
- *
- * This can mean communicating with a particular servlet engine instance,
- * using a particular protocol. A single web server instance may have
- * multiple workers communicating with a single servlet engine (it could be
- * using ajp12 for some requests and ajp13/ajp14 for others). Or, a single web
- * server instance could have multiple workers communicating with different
- * servlet engines using the same protocol (it could be load balancing
- * among many engines, using ajp13/ajp14 for all communication).
- *
- * There is also a load balancing worker (jk_lb_worker.c), which itself
- * manages a group of workers.
- *
- * Web servers are configured to forward requests to a given worker. To
- * handle those requests, the worker's get_endpoint method is called, and
- * then the service() method of that endpoint is called.
- *
- * As with all the core jk classes, this is essentially an abstract base
- * class which is implemented/extended by classes which are specific to a
- * particular protocol (or request-handling system). By using an abstract
- * base class in this manner, plugins can be written for different servers
- * (e.g. IIS, Apache) without the plugins having to worry about which
- * protocol they are talking.
- *
- * This particular OO-in-C system uses a 'worker_private' pointer to
- * point to the protocol-specific data/functions. So in the subclasses, the
- * methods do most of their work by getting their hands on the
- * worker_private pointer and then using that to get at the functions for
- * their protocol.
- *
- * Try imagining this as a 'public abstract class', and the
- * worker_private pointer as a sort of extra 'this' reference. Or
- * imagine that you are seeing the internal vtables of your favorite OO
- * language. Whatever works for you.
- *
- * See jk_ajp14_worker.c, jk_ajp13_worker.c and jk_ajp12_worker.c for examples.
- */
-struct jk_worker {
-
- /*
- * A 'this' pointer which is used by the subclasses of this class to
- * point to data/functions which are specific to a given protocol
- * (e.g. ajp12 or ajp13 or ajp14).
- */
- void *worker_private;
-
- /* XXX Add name and all other common properties !!!
- */
-
- /** Communication channle used by the worker
- */
- struct jk_channel *channel;
-
- /*
- * For all of the below (except destroy), the first argument is
- * essentially a 'this' pointer.
- */
-
- /*
- * Given a worker which is in the process of being created, and a list
- * of configuration options (or 'properties'), check to see if it the
- * options are. This will always be called before the init() method.
- * The init/validate distinction is a bit hazy to me.
- * See jk_ajp13_worker.c/jk_ajp14_worker.c and jk_worker.c->wc_create_worker()
- */
- int (JK_METHOD *validate)(jk_worker_t *w,
- jk_map_t *props,
- jk_worker_env_t *we,
- jk_logger_t *l);
-
- /*
- * Do whatever initialization needs to be done to start this worker up.
- * Configuration options are passed in via the props parameter.
- */
- int (JK_METHOD *init)(jk_worker_t *w,
- jk_map_t *props,
- jk_worker_env_t *we,
- jk_logger_t *l);
-
-
- /*
- * Obtain an endpoint to service a particular request. A pointer to
- * the endpoint is stored in pend.
- */
- int (JK_METHOD *get_endpoint)(jk_worker_t *w,
- jk_endpoint_t **pend,
- jk_logger_t *l);
-
- /*
- * Shutdown this worker. The first argument is not a 'this' pointer,
- * but rather a pointer to 'this', so that the object can be free'd (I
- * think -- though that doesn't seem to be happening. Hmmm).
- */
- int (JK_METHOD *destroy)(jk_worker_t **w,
- jk_logger_t *l);
-};
-
-/*
- * Essentially, an abstract base class (or factory class) with a single
- * method -- think of it as createWorker() or the Factory Method Design
- * Pattern. There is a different worker_factory function for each of the
- * different types of workers. The set of all these functions is created
- * at startup from the list in jk_worker_list.h, and then the correct one
- * is chosen in jk_worker.c->wc_create_worker(). See jk_worker.c and
- * jk_ajp13_worker.c/jk_ajp14_worker.c for examples.
- *
- * This allows new workers to be written without modifing the plugin code
- * for the various web servers (since the only link is through
- * jk_worker_list.h).
- */
-typedef int (JK_METHOD *worker_factory)(jk_worker_t **w,
- const char *name,
- jk_logger_t *l);
#ifdef __cplusplus
}
1.1 jakarta-tomcat-connectors/jk/native/common/jk_endpoint.h
Index: jk_endpoint.h
===================================================================
/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil-*- */
/* ========================================================================= *
* *
* The Apache Software License, Version 1.1 *
* *
* Copyright (c) 1999-2001 The Apache Software Foundation. *
* All rights reserved. *
* *
* ========================================================================= *
* *
* Redistribution and use in source and binary forms, with or without modi- *
* fication, are permitted provided that the following conditions are met: *
* *
* 1. Redistributions of source code must retain the above copyright notice *
* notice, this list of conditions and the following disclaimer. *
* *
* 2. Redistributions in binary form must reproduce the above copyright *
* notice, this list of conditions and the following disclaimer in the *
* documentation and/or other materials provided with the distribution. *
* *
* 3. The end-user documentation included with the redistribution, if any, *
* must include the following acknowlegement: *
* *
* "This product includes software developed by the Apache Software *
* Foundation <http://www.apache.org/>." *
* *
* Alternately, this acknowlegement may appear in the software itself, if *
* and wherever such third-party acknowlegements normally appear. *
* *
* 4. The names "The Jakarta Project", "Jk", and "Apache Software *
* Foundation" must not be used to endorse or promote products derived *
* from this software without prior written permission. For written *
* permission, please contact <[EMAIL PROTECTED]>. *
* *
* 5. Products derived from this software may not be called "Apache" nor may *
* "Apache" appear in their names without prior written permission of the *
* Apache Software Foundation. *
* *
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES *
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY *
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY *
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL *
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS *
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) *
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, *
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN *
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
* POSSIBILITY OF SUCH DAMAGE. *
* *
* ========================================================================= *
* *
* This software consists of voluntary contributions made by many indivi- *
* duals on behalf of the Apache Software Foundation. For more information *
* on the Apache Software Foundation, please see <http://www.apache.org/>. *
* *
* ========================================================================= */
/***************************************************************************
* Description: Definitions of the endpoint.
*
* Author: Gal Shachor <[EMAIL PROTECTED]>
* Author: Dan Milstein <[EMAIL PROTECTED]>
* Author: Henri Gomez <[EMAIL PROTECTED]>
* Version: $Revision: 1.1 $
***************************************************************************/
#ifndef JK_ENDPOINT_H
#define JK_ENDPOINT_H
#include "jk_map.h"
#include "jk_service.h"
#include "jk_logger.h"
#include "jk_pool.h"
#include "jk_uri_worker_map.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
struct jk_endpoint;
struct jk_ws_service;
typedef struct jk_endpoint jk_endpoint_t;
/*
* The endpoint 'class', which represents one end of a connection to the
* servlet engine. Basically, supports nothing other than forwarding the
* request to the servlet engine. Endpoints can be persistent (as with
* ajp13/ajp14, where a single connection is reused many times), or can last for a
* single request (as with ajp12, where a new connection is created for
* every request).
*
* An endpoint for a given protocol is obtained by the web server plugin
* from a worker object for that protocol. See below for details.
*
* As with all the core jk classes, this is essentially an abstract base
* class which is implemented/extended by classes which are specific to a
* particular protocol. By using an abstract base class in this manner,
* plugins can be written for different servers (e.g. IIS, Apache) without
* the plugins having to worry about which protocol they are talking.
*
* This particular OO-in-C system uses a 'endpoint_private' pointer to
* point to the protocol-specific data/functions. So in the subclasses, the
* methods do most of their work by getting their hands on the
* endpoint_private pointer and then using that to get at the functions for
* their protocol.
*
* Try imagining this as a 'public abstract class', and the
* endpoint_private pointer as a sort of extra 'this' reference. Or
* imagine that you are seeing the internal vtables of your favorite OO
* language. Whatever works for you.
*
* See jk_ajp13_worker.c/jk_ajp14_worker.c and jk_ajp12_worker.c for examples.
*/
struct jk_endpoint {
/*
* A 'this' pointer which is used by the subclasses of this class to
* point to data/functions which are specific to a given protocol
* (e.g. ajp12 or ajp13 or ajp14).
*/
void *endpoint_private;
/** Data specific to a channel connection
*/
void *channelData;
/*
* Forward a request to the servlet engine. The request is described
* by the jk_ws_service_t object. I'm not sure exactly how
* is_recoverable_error is being used.
*/
int (JK_METHOD *service)(jk_endpoint_t *e,
struct jk_ws_service *s,
jk_logger_t *l,
int *is_recoverable_error);
/*
* Called when this particular endpoint has finished processing a
* request. For some protocols (e.g. ajp12), this frees the memory
* associated with the endpoint. For others (e.g. ajp13/ajp14), this can
* return the endpoint to a cache of already opened endpoints.
*
* Note that the first argument is *not* a 'this' pointer, but is
* rather a pointer to a 'this' pointer. This is necessary, because
* we may need to free this object.
*/
int (JK_METHOD *done)(jk_endpoint_t **p,
jk_logger_t *l);
};
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* JK_ENDPOINT_H */
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
