mpm_status.h revision 3d96ee83babeec32482c9082c9426340cee8c44d
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering/* ====================================================================
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * The Apache Software License, Version 1.1
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * Copyright (c) 2000 The Apache Software Foundation. All rights
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * Redistribution and use in source and binary forms, with or without
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * modification, are permitted provided that the following conditions
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * 1. Redistributions of source code must retain the above copyright
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * notice, this list of conditions and the following disclaimer.
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * 2. Redistributions in binary form must reproduce the above copyright
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * notice, this list of conditions and the following disclaimer in
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * the documentation and/or other materials provided with the
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * distribution.
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * 3. The end-user documentation included with the redistribution,
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * if any, must include the following acknowledgment:
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * "This product includes software developed by the
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * Apache Software Foundation (http://www.apache.org/)."
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * Alternately, this acknowledgment may appear in the software itself,
5c8da64734d7dbf4058b3f9f89268f1e093a47b6Lennart Poettering * if and wherever such third-party acknowledgments normally appear.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * 4. The names "Apache" and "Apache Software Foundation" must
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * not be used to endorse or promote products derived from this
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * software without prior written permission. For written
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * permission, please contact apache@apache.org.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * 5. Products derived from this software may not be called "Apache",
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * nor may "Apache" appear in their name, without prior written
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * permission of the Apache Software Foundation.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * ====================================================================
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * This software consists of voluntary contributions made by many
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * individuals on behalf of the Apache Software Foundation. For more
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * information on the Apache Software Foundation, please see
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * TODO: Possible additions to this API include getting a list of connection
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * IDs and a list of keys in a particular row.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @package MPM Status API
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektypedef struct ap_status_table_row_t ap_status_table_row_t;
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * The MPM status table row structure. MPMs should use this structure in
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * a table to store the status for the requests. This structure stores the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * status for one connection
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The connection id. This is used as a key for the status table */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The actual status. This is a table of key-value pairs */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Get a cell from the status table. Don't mess with the string you get.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param conn_id Connection ID of the current connection
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param key The key to determine which status value should be retrieved
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * for the connection.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc const char *ap_get_connection_status(long conn_id, const char *key)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekAP_DECLARE(const char *) ap_get_connection_status(long conn_id, const char *key);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Get an array of current connection IDs.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param p The pool to allocate the array out of
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @return An array of all the current connection IDs
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc apr_array_header_t *ap_get_connections(apr_pool_t *p)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekAP_DECLARE(apr_array_header_t *) ap_get_connections(apr_pool_t *p);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Get an array of keys from a given connection.
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @param p Pool to allocate out of
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @param conn_id Connection ID to get the keys for
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @return an array of keys from a given connection
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @deffunc apr_array_header_t *ap_get_connection_keys(apr_pool_t *p, long conn_id)
707b66c66381c899d7ef640e158ffdd5bcff4debLennart PoetteringAP_DECLARE(apr_array_header_t *) ap_get_connection_keys(apr_pool_t *p,
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * Set a cell in the status table. No guarantees are made that long strings
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * won't be truncated.
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @param conn_id Connection ID to update
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @param key key to update
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @param value value to set for the key
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @deffunc void ap_update_connection_status(long conn_id, const char *key, const char *value)
707b66c66381c899d7ef640e158ffdd5bcff4debLennart PoetteringAP_DECLARE(void) ap_update_connection_status(long conn_id, const char *key, const char *value);
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * Clear out this connection's status values. Normally called when a
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * connection is closed
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @param conn_id The connection ID to clear
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * @deffunc void ap_reset_connection_status(long conn_id)
707b66c66381c899d7ef640e158ffdd5bcff4debLennart PoetteringAP_DECLARE(void) ap_reset_connection_status(long conn_id);
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * Returns the most up-to-date status table available, in the form of an array
707b66c66381c899d7ef640e158ffdd5bcff4debLennart Poettering * of ap_status_row_t's.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param p pool to allocate the array out of, generally from the request_rec
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @return The table of statuses for all connections
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @deffunc apr_array_header_t *ap_get_status_table(apr_pool_t *p)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekAP_DECLARE(apr_array_header_t *) ap_get_status_table(apr_pool_t *p);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#endif /* APACHE_SERVER_STATS_H */