Final ( :) ) step to transition which removes the ap_slotmem_foo

API and just does providers direct


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@775176 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 22 insertions, 115 deletions

diff --git a/include/ap_slotmem.h b/include/ap_slotmem.h
index e59ef72096..219556e179 100644
--- a/include/ap_slotmem.h
+++ b/include/ap_slotmem.h
@@ -48,13 +48,16 @@
 #include <unistd.h>         /* for getpid() */
 #endif
 
-#define AP_SLOTMEM_STORAGE "slotmem"
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define AP_SLOTMEM_PROVIDER_GROUP "slotmem"
+#define AP_SLOTMEM_PROVIDER_VERSION 0
 
-typedef enum {
-    SLOTMEM_PERSIST      /* create a persistent slotmem */
-} apslotmem_type;
+typedef unsigned int ap_slotmem_type_t;
 
-typedef struct ap_slotmem_t ap_slotmem_t;
+typedef struct ap_slotmem_instance_t ap_slotmem_instance_t;
 
 /**
  * callback function used for slotmem.
@@ -65,7 +68,7 @@ typedef struct ap_slotmem_t ap_slotmem_t;
  */
 typedef apr_status_t ap_slotmem_callback_fn_t(void* mem, void *data, apr_pool_t *pool);
 
-struct ap_slotmem_storage_method {
+struct ap_slotmem_provider_t {
     /*
      * Name of the provider method
      */
@@ -78,7 +81,7 @@ struct ap_slotmem_storage_method {
      * @param pool is pool used
      * @return APR_SUCCESS if all went well
      */
-    apr_status_t (* slotmem_do)(ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool);
+    apr_status_t (* doall)(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool);
     /**
      * create a new slotmem with each item size is item_size.
      * This would create shared memory, basically.
@@ -89,7 +92,7 @@ struct ap_slotmem_storage_method {
      * @param pool is pool used
      * @return APR_SUCCESS if all went well
      */
-    apr_status_t (* slotmem_create)(ap_slotmem_t **new, const char *name, apr_size_t item_size, unsigned int item_num, apslotmem_type type, apr_pool_t *pool);
+    apr_status_t (* create)(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool);
     /**
      * attach to an existing slotmem.
      * This would attach to  shared memory, basically.
@@ -99,7 +102,7 @@ struct ap_slotmem_storage_method {
      * @param pool is pool to memory allocate.
      * @return APR_SUCCESS if all went well
      */
-    apr_status_t (* slotmem_attach)(ap_slotmem_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool);
+    apr_status_t (* attach)(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool);
     /**
      * get the memory ptr associated with this worker slot.
      * @param s ap_slotmem_t to use.
@@ -107,7 +110,7 @@ struct ap_slotmem_storage_method {
      * @param mem address to store the pointer to the slot
      * @return APR_SUCCESS if all went well
      */
-    apr_status_t (* slotmem_mem)(ap_slotmem_t *s, unsigned int item_id, void**mem);
+    apr_status_t (* dptr)(ap_slotmem_instance_t *s, unsigned int item_id, void**mem);
     /**
      * retrieve the memory associated with this worker slot.
      * @param s ap_slotmem_t to use.
@@ -116,7 +119,7 @@ struct ap_slotmem_storage_method {
      * @param dest_len length of dataset to retrieve
      * @return APR_SUCCESS if all went well
      */
-    apr_status_t (* slotmem_get)(ap_slotmem_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len);
+    apr_status_t (* get)(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len);
     /**
      * store the memory associated with this worker slot.
      * @param s ap_slotmem_t to use.
@@ -125,120 +128,24 @@ struct ap_slotmem_storage_method {
      * @param src_len length of dataset to store in the slot
      * @return APR_SUCCESS if all went well
      */
-    apr_status_t (* slotmem_put)(ap_slotmem_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len);
+    apr_status_t (* put)(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len);
     /**
      * return number of slots allocated for this entry.
      * @param s ap_slotmem_t to use.
      * @return number of slots
      */
-    unsigned int (* slotmem_num_slots)(ap_slotmem_t *s);
+    unsigned int (* num_slots)(ap_slotmem_instance_t *s);
     /**
      * return slot size allocated for this entry.
      * @param s ap_slotmem_t to use.
      * @return size of slot
      */
-    apr_size_t (* slotmem_slot_size)(ap_slotmem_t *s);
+    apr_size_t (* slot_size)(ap_slotmem_instance_t *s);
 };
 
-typedef struct ap_slotmem_storage_method ap_slotmem_storage_method;
-
-/*
- * mod_slotmem externals exposed to the outside world.
- *  Thus the provider nature of mod_slotmem is somewhat insulated
- *  from the end user but can still be used directed if need
- *  be. The rationale is to make it easier for additional
- *  memory providers to be provided and having a single
- *  simple interface for all
- */
-/**
- * obtain the array of provider methods desired
- * @param pool is the pool to use
- * @return pointer to array of provider names available
- */
-AP_DECLARE(apr_array_header_t *) ap_slotmem_methods(apr_pool_t *pool);
-/**
- * obtain the provider method desired
- * @param provider is name of the provider to use
- * @return pointer to provider or NULL
- */
-AP_DECLARE(ap_slotmem_storage_method *) ap_slotmem_method(const char *provider);
-/**
- * call the callback on all worker slots
- * @param sm ap_slotmem_storage_method provider obtained
- * @param s ap_slotmem_t to use.
- * @param funct callback function to call for each element.
- * @param data parameter for the callback function.
- * @param pool is pool used
- * @return APR_SUCCESS if all went well
- */
-AP_DECLARE(apr_status_t) ap_slotmem_do(ap_slotmem_storage_method *sm, ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool);
-
-/**
- * create a new slotmem with each item size is item_size.
- * This would create shared memory, basically.
- * @param sm ap_slotmem_storage_method provider obtained
- * @param name is a key used for debugging and in mod_status output or allow another process to share this space.
- * @param item_size size of each item
- * @param item_num number of item to create.
- * @param type (persistent/allocatable/etc)
- * @param pool is pool used
- * @return APR_SUCCESS if all went well
- */
-AP_DECLARE(apr_status_t) ap_slotmem_create(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t item_size, unsigned int item_num, apslotmem_type type, apr_pool_t *pool);
-
-/**
- * attach to an existing slotmem.
- * This would attach to  shared memory, basically.
- * @param sm ap_slotmem_storage_method provider obtained
- * @param name is a key used for debugging and in mod_status output or allow another process to share this space.
- * @param item_size size of each item
- * @param item_num max number of item.
- * @param pool is pool to memory allocate.
- * @return APR_SUCCESS if all went well
- */
-AP_DECLARE(apr_status_t) ap_slotmem_attach(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool);
-/**
- * get the memory associated with this worker slot.
- * @param sm ap_slotmem_storage_method provider obtained
- * @param s ap_slotmem_t to use.
- * @param item_id item to return for 0 to item_num
- * @param mem address to store the pointer to the slot
- * @return APR_SUCCESS if all went well
- */
-AP_DECLARE(apr_status_t) ap_slotmem_mem(ap_slotmem_storage_method *sm, ap_slotmem_t *s, unsigned int item_id, void**mem);
-/**
- * retrieve the memory associated with this worker slot.
- * @param sm ap_slotmem_storage_method provider obtained
- * @param s ap_slotmem_t to use.
- * @param item_id item to return for 0 to item_num
- * @param dest address to store the data
- * @param dest_len length of dataset to retrieve
- * @return APR_SUCCESS if all went well
- */
-AP_DECLARE(apr_status_t) ap_slotmem_get(ap_slotmem_storage_method *sm, ap_slotmem_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len);
-/**
- * store the memory associated with this worker slot.
- * @param sm ap_slotmem_storage_method provider obtained
- * @param s ap_slotmem_t to use.
- * @param item_id item to return for 0 to item_num
- * @param src address of the data to store in the slot
- * @param src_len length of dataset to store in the slot
- * @return APR_SUCCESS if all went well
- */
-AP_DECLARE(apr_status_t) ap_slotmem_put(ap_slotmem_storage_method *sm, ap_slotmem_t *s, unsigned int item_id, unsigned char *src, apr_size_t src_len);
-/**
- * return number of slots allocated for this entry.
- * @param sm ap_slotmem_storage_method provider obtained
- * @param s ap_slotmem_t to use.
- * @return number of slots
- */
-AP_DECLARE(unsigned int) ap_slotmem_num_slots(ap_slotmem_storage_method *sm, ap_slotmem_t *s);
-/**
- * return slot size allocated for this entry.
- * @param sm ap_slotmem_storage_method provider obtained
- * @param s ap_slotmem_t to use.
- * @return size of slot
- */
-AP_DECLARE(apr_size_t) ap_slotmem_slot_size(ap_slotmem_storage_method *sm, ap_slotmem_t *s);
+#ifdef __cplusplus
+}
+#endif
 
-#endif /*SLOTMEM_H*/
+#endif
+/** @} */