You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by pi...@apache.org on 2006/07/28 04:56:04 UTC
svn commit: r426364 -
/webservices/axis2/trunk/c/include/axis2_http_svr_thread.h
Author: pini
Date: Thu Jul 27 19:56:04 2006
New Revision: 426364
URL: http://svn.apache.org/viewvc?rev=426364&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_http_svr_thread.h
Modified: webservices/axis2/trunk/c/include/axis2_http_svr_thread.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_svr_thread.h?rev=426364&r1=426363&r2=426364&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_svr_thread.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_svr_thread.h Thu Jul 27 19:56:04 2006
@@ -17,12 +17,17 @@
#ifndef AXIS2_HTTP_SVR_THREAD_H
#define AXIS2_HTTP_SVR_THREAD_H
+/**
+ * @defgroup axis2_http_svr_thread http server thread
+ * @ingroup axis2_core_trans_http
+ * @{
+ */
/**
- * @file axis2_http_svr_thread.h
- * @brief axis2 HTTP server listning thread implementation
- */
-
+ * @file axis2_http_svr_thread.h
+ * @brief axis2 HTTP server listning thread implementation
+ */
+
#include <axis2_const.h>
#include <axis2_defines.h>
#include <axis2_env.h>
@@ -33,72 +38,129 @@
{
#endif
-/**
- * @ingroup axis2_core_transport_http
- * @{
- */
+ /** Type name for struct axist_http_svr_thread_ops */
+ typedef struct axis2_http_svr_thread_ops axis2_http_svr_thread_ops_t;
+ /** Type name for struct axist_http_svr_thread */
+ typedef struct axis2_http_svr_thread axis2_http_svr_thread_t;
+
+ extern int axis2_http_socket_read_timeout;
+
+ /**
+ * HTTP Server Thread ops struct
+ * Encapsulator struct for ops of axis2_http_svr_thread
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_svr_thread_ops
+ {
+ /**
+ * @param svr_thread pointer to server thread
+ * @param env pointer to environment struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ run)(
+ axis2_http_svr_thread_t *svr_thread,
+ const axis2_env_t *env);
-typedef struct axis2_http_svr_thread_ops axis2_http_svr_thread_ops_t;
-typedef struct axis2_http_svr_thread axis2_http_svr_thread_t;
+ /**
+ * @param svr_thread pointer to server thread
+ * @param env pointer to environment struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ destroy)(
+ axis2_http_svr_thread_t *svr_thread,
+ const axis2_env_t *env);
-extern int axis2_http_socket_read_timeout;
-
-/**
- * @brief HTTP Server Thread ops struct
- * Encapsulator struct for ops of axis2_http_svr_thread
- */
-AXIS2_DECLARE_DATA struct axis2_http_svr_thread_ops
-{
- axis2_status_t (AXIS2_CALL *run)
- (axis2_http_svr_thread_t *svr_thread,
- const axis2_env_t *env);
- axis2_status_t (AXIS2_CALL *destroy)
- (axis2_http_svr_thread_t *svr_thread,
- const axis2_env_t *env);
- int (AXIS2_CALL *get_local_port)
- (axis2_http_svr_thread_t *svr_thread,
- const axis2_env_t *env);
- axis2_bool_t (AXIS2_CALL *is_running)
- (axis2_http_svr_thread_t *svr_thread,
- const axis2_env_t *env);
- axis2_status_t (AXIS2_CALL *set_worker)
- (axis2_http_svr_thread_t *svr_thread,
- const axis2_env_t *env, axis2_http_worker_t *worker);
- axis2_status_t (AXIS2_CALL *free)
- (axis2_http_svr_thread_t *svr_thread,
+ /**
+ * @param svr_thread pointer to server thread
+ * @param env pointer to environment struct
+ */
+ int (AXIS2_CALL *
+ get_local_port)(
+ axis2_http_svr_thread_t *svr_thread,
const axis2_env_t *env);
-};
-/**
- * @brief HTTP Server Thread struct
- * Axis2 HTTP Server Thread
- */
-AXIS2_DECLARE_DATA struct axis2_http_svr_thread
-{
- axis2_http_svr_thread_ops_t *ops;
-};
+ /**
+ * @param svr_thread pointer to server thread
+ * @param env pointer to environment struct
+ */
+ axis2_bool_t (AXIS2_CALL *
+ is_running)(
+ axis2_http_svr_thread_t *svr_thread,
+ const axis2_env_t *env);
+ /**
+ * @param svr_thread pointer to server thread
+ * @param env pointer to environment struct
+ * @param worker pointer to worker
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_worker)(
+ axis2_http_svr_thread_t *svr_thread,
+ const axis2_env_t *env,
+ axis2_http_worker_t *worker);
+
+ /**
+ * @param svr_thread pointer to server thread
+ * @param env pointer to environment struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(
+ axis2_http_svr_thread_t *svr_thread,
+ const axis2_env_t *env);
+ };
-AXIS2_EXTERN axis2_http_svr_thread_t * AXIS2_CALL
-axis2_http_svr_thread_create (const axis2_env_t *env, int port);
+ /**
+ * axis2 http server thread
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_svr_thread
+ {
+ /** operations of axis2 http server thread */
+ axis2_http_svr_thread_ops_t *ops;
+ };
+
+ /**
+ * @param env pointer to environment struct
+ * @param port
+ */
+ AXIS2_EXTERN axis2_http_svr_thread_t * AXIS2_CALL
+ axis2_http_svr_thread_create (
+ const axis2_env_t *env,
+ int port);
/************************** Start of function macros **************************/
+/** Run.
+ @sa axis2_http_svr_thread_ops#run */
#define AXIS2_HTTP_SVR_THREAD_RUN(svr_thread, env) \
((svr_thread)->ops->run(svr_thread, env))
+
+/** Destroy.
+ @sa axis2_http_svr_thread_ops#destroy */
#define AXIS2_HTTP_SVR_THREAD_DESTROY(svr_thread, env) \
((svr_thread)->ops->destroy(svr_thread, env))
+
+/** Gets the local port.
+ @sa axis2_http_svr_thread_ops#get_local_port */
#define AXIS2_HTTP_SVR_THREAD_GET_LOCAL_PORT(svr_thread, env) \
((svr_thread)->ops->get_local_port(svr_thread,\
env))
+
+/** Is running.
+ @sa axis2_http_svr_thread_ops#is_running */
#define AXIS2_HTTP_SVR_THREAD_IS_RUNNING(svr_thread, env) \
((svr_thread)->ops->is_running(svr_thread, env))
+
+/** Set worker.
+ @sa axis2_http_svr_thread_ops#set_worker */
#define AXIS2_HTTP_SVR_THREAD_SET_WORKER(svr_thread, env, worker) \
((svr_thread)->ops->set_worker(svr_thread, env,\
worker))
+
+/** Frees the http_svr_thread.
+ @sa axis2_http_svr_thread_ops#free */
#define AXIS2_HTTP_SVR_THREAD_FREE(svr_thread, env) \
((svr_thread)->ops->free(svr_thread, env))
-/************************** End of function macros ****************************/
+
+/************************** End of function macros ****************************/
/** @} */
#ifdef __cplusplus
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org