You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by pi...@apache.org on 2006/07/27 16:43:29 UTC
svn commit: r426091 - in /webservices/axis2/trunk/c/include:
axis2_http_server.h axis2_http_simple_request.h
Author: pini
Date: Thu Jul 27 07:43:29 2006
New Revision: 426091
URL: http://svn.apache.org/viewvc?rev=426091&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_http_server.h
webservices/axis2/trunk/c/include/axis2_http_simple_request.h
Modified: webservices/axis2/trunk/c/include/axis2_http_server.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_server.h?rev=426091&r1=426090&r2=426091&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_server.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_server.h Thu Jul 27 07:43:29 2006
@@ -1,28 +1,33 @@
/*
- * Copyright 2004,2005 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright 2004,2005 The Apache Software Foundation.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
#ifndef AXIS2_HTTP_SERVER_H
#define AXIS2_HTTP_SERVER_H
+/**
+ * @defgroup axis2_http_server http server
+ * @ingroup axis2_core_trans_http
+ * @{
+ */
/**
* @file axis2_http_server.h
* @brief axis2 HTTP Server implementation
*/
-
+
#include <axis2_const.h>
#include <axis2_defines.h>
#include <axis2_env.h>
@@ -34,21 +39,19 @@
{
#endif
-/**
- * @ingroup axis2_core_transport_http
- * @{
- */
-int axis2_http_socket_read_timeout = 0;
-
-
-AXIS2_EXTERN axis2_transport_receiver_t * AXIS2_CALL
-axis2_http_server_create (const axis2_env_t *env,
- const axis2_char_t *repo,
- const int port);
-
-axis2_status_t AXIS2_CALL
-axis2_http_server_stop(axis2_transport_receiver_t *server,
- const axis2_env_t *env);
+ int axis2_http_socket_read_timeout = 0;
+
+
+ AXIS2_EXTERN axis2_transport_receiver_t * AXIS2_CALL
+ axis2_http_server_create (
+ const axis2_env_t *env,
+ const axis2_char_t *repo,
+ const int port);
+
+ axis2_status_t AXIS2_CALL
+ axis2_http_server_stop(
+ axis2_transport_receiver_t *server,
+ const axis2_env_t *env);
/** @} */
Modified: webservices/axis2/trunk/c/include/axis2_http_simple_request.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_simple_request.h?rev=426091&r1=426090&r2=426091&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_simple_request.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_simple_request.h Thu Jul 27 07:43:29 2006
@@ -1,27 +1,32 @@
/*
- * Copyright 2004,2005 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright 2004,2005 The Apache Software Foundation.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
#ifndef AXIS2_HTTP_SIMPLE_REQUEST_H
#define AXIS2_HTTP_SIMPLE_REQUEST_H
+/**
+ * @defgroup axis2_http_simple_request http simple request
+ * @ingroup axis2_core_trans_http
+ * @{
+ */
/**
- * @file axis2_http_simple_request.h
- * @brief axis2 HTTP Simple Request
- */
+ * @file axis2_http_simple_request.h
+ * @brief axis2 HTTP Simple Request
+ */
#include <axis2_const.h>
#include <axis2_defines.h>
@@ -37,143 +42,275 @@
{
#endif
-/**
- * @ingroup axis2_core_transport_http
- * @{
- */
- typedef struct axis2_http_simple_request_ops
- axis2_http_simple_request_ops_t;
- typedef struct axis2_http_simple_request axis2_http_simple_request_t;
-
-/**
- * @brief HTTP Simple Request ops struct
- * Encapsulator struct for ops of axis2_http_simple_request
- */
-AXIS2_DECLARE_DATA struct axis2_http_simple_request_ops
-{
- axis2_http_request_line_t* (AXIS2_CALL *get_request_line)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *set_request_line)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env,
- axis2_http_request_line_t *request_line);
-
- axis2_bool_t (AXIS2_CALL *contains_header)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env,
- const axis2_char_t *name);
-
- axis2_array_list_t* (AXIS2_CALL *get_headers)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env);
-
- axis2_http_header_t* (AXIS2_CALL *get_first_header)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env, const axis2_char_t *str);
-
- axis2_status_t (AXIS2_CALL *remove_headers)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env, const axis2_char_t *str);
-
- axis2_status_t (AXIS2_CALL *add_header)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env, axis2_http_header_t *header);
-
- const axis2_char_t* (AXIS2_CALL *get_content_type)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env);
-
- const axis2_char_t* (AXIS2_CALL *get_charset)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env);
-
- axis2_ssize_t (AXIS2_CALL *get_content_length)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env);
-
- axis2_stream_t* (AXIS2_CALL *get_body)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env);
-
- axis2_ssize_t (AXIS2_CALL *get_body_bytes)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env, char **buf);
-
- axis2_status_t (AXIS2_CALL *set_body_string)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env, axis2_char_t *str);
-
- axis2_status_t (AXIS2_CALL *free)
- (axis2_http_simple_request_t *simple_request,
- const axis2_env_t *env);
-
-};
-
-/**
- * @brief HTTP Simple Request struct
- * Axis2 HTTP Simple Request
- */
-AXIS2_DECLARE_DATA struct axis2_http_simple_request
-{
- axis2_http_simple_request_ops_t *ops;
-};
-
+ /** Type name for struct axis2_http_simple_request_ops */
+ typedef struct axis2_http_simple_request_ops
+ axis2_http_simple_request_ops_t;
+ /** Type name for struct axis2_http_simple_request */
+ typedef struct axis2_http_simple_request axis2_http_simple_request_t;
+
+ /**
+ * HTTP Simple Request ops struct
+ * Encapsulator struct for ops of axis2_http_simple_request
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_simple_request_ops
+ {
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ */
+ axis2_http_request_line_t* (AXIS2_CALL *
+ get_request_line)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @param request_line pointer to request line
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_request_line)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env,
+ axis2_http_request_line_t *request_line);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @param name pointer to name
+ */
+ axis2_bool_t (AXIS2_CALL *
+ contains_header)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env,
+ const axis2_char_t *name);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t* (AXIS2_CALL *
+ get_headers)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @param str pointer to str
+ */
+ axis2_http_header_t* (AXIS2_CALL *
+ get_first_header)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env,
+ const axis2_char_t *str);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @param str pointer to str
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ remove_headers)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env,
+ const axis2_char_t *str);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @param header pointer to header
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ add_header)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env,
+ axis2_http_header_t *header);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ */
+ const axis2_char_t* (AXIS2_CALL *
+ get_content_type)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ */
+ const axis2_char_t* (AXIS2_CALL *
+ get_charset)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ */
+ axis2_ssize_t (AXIS2_CALL *
+ get_content_length)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ */
+ axis2_stream_t* (AXIS2_CALL *
+ get_body)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @param buf double pointer to buf
+ */
+ axis2_ssize_t (AXIS2_CALL *
+ get_body_bytes)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env,
+ char **buf);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @param str pointer to str
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_body_string)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env,
+ axis2_char_t *str);
+
+ /**
+ * @param simple_request pointer to simple request
+ * @param env pointer to environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(
+ axis2_http_simple_request_t *simple_request,
+ const axis2_env_t *env);
+
+ };
+
+ /**
+ * axis2 http simple request
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_simple_request
+ {
+ /** operations of axis2 http simple request */
+ axis2_http_simple_request_ops_t *ops;
+ };
+
+ /**
+ * @param env pointer to environment struct
+ * @param request_line pointer to request line
+ * @param http_headers double pointer to http headers
+ * @param http_hdr_count
+ * @param content pointer to content
+ */
+ AXIS2_EXTERN axis2_http_simple_request_t * AXIS2_CALL
+ axis2_http_simple_request_create (
+ const axis2_env_t *env,
+ axis2_http_request_line_t *request_line,
+ axis2_http_header_t **http_headers,
+ axis2_ssize_t http_hdr_count,
+ axis2_stream_t *content);
-AXIS2_EXTERN axis2_http_simple_request_t * AXIS2_CALL
-axis2_http_simple_request_create (const axis2_env_t *env,
- axis2_http_request_line_t *request_line,
- axis2_http_header_t **http_headers,
- axis2_ssize_t http_hdr_count,
- axis2_stream_t *content);
-
/************************** Start of function macros **************************/
-
+/** Gets the request line.
+ @sa axis2_http_simple_request_ops#get_request_line */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_REQUEST_LINE(simple_request, env) \
((simple_request)->ops->get_request_line\
(simple_request, env))
+
+/** Sets the request line.
+ @sa axis2_http_simple_request_ops#set_request_line */
#define AXIS2_HTTP_SIMPLE_REQUEST_SET_REQUEST_LINE\
(simple_request, env, request_line) \
((simple_request)->ops->set_request_line\
(simple_request, env, request_line))
+
+/** Contains header.
+ @sa axis2_http_simple_request_ops#contains_header */
#define AXIS2_HTTP_SIMPLE_REQUEST_CONTAINS_HEADER(simple_request, env, name)\
((simple_request)->ops->contains_header\
(simple_request, env, name))
+
+/** Gets the headers.
+ @sa axis2_http_simple_request_ops#get_headers */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_HEADERS(simple_request, env)\
((simple_request)->ops->get_headers(simple_request, env))
+
+/** Gets the first header.
+ @sa axis2_http_simple_request_ops#get_first_header */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_FIRST_HEADER(simple_request, env, str) \
((simple_request)->ops->get_first_header\
(simple_request, env, str))
+
+/** Removes the headers.
+ @sa axis2_http_simple_request_ops#remove_headers */
#define AXIS2_HTTP_SIMPLE_REQUEST_REMOVE_HEADERS(simple_request, env, str) \
((simple_request)->ops->remove_headers\
(simple_request, env, str))
+
+/** Adds the header.
+ @sa axis2_http_simple_request_ops#add_header */
#define AXIS2_HTTP_SIMPLE_REQUEST_ADD_HEADER(simple_request, env, header) \
((simple_request)->ops->add_header\
(simple_request, env, header))
+
+/** Gets the content type.
+ @sa axis2_http_simple_request_ops#get_content_type */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_CONTENT_TYPE(simple_request, env)\
((simple_request)->ops->get_content_type\
(simple_request, env))
+
+/** Gets the charset.
+ @sa axis2_http_simple_request_ops#get_charset */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_CHARSET(simple_request, env) \
((simple_request)->ops->get_charset\
(simple_request, env))
+
+/** Gets the content length.
+ @sa axis2_http_simple_request_ops#get_content_length */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_CONTENT_LENGTH(simple_request, env)\
((simple_request)->ops->get_content_length\
(simple_request, env))
+
+/** Gets the body.
+ @sa axis2_http_simple_request_ops#get_body */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_BODY(simple_request, env)\
((simple_request)->ops->get_body\
(simple_request, env))
+
+/** Get body bytes.
+ @sa axis2_http_simple_request_ops#get_body_bytes */
#define AXIS2_HTTP_SIMPLE_REQUEST_GET_BODY_BYTES(simple_request, env, buf)\
((simple_request)->ops->get_body_bytes\
(simple_request, env, buf))
+
+/** Sets the body string.
+ @sa axis2_http_simple_request_ops#set_body_string */
#define AXIS2_HTTP_SIMPLE_REQUEST_SET_BODY_STRING(simple_request, env, str)\
((simple_request)->ops->set_body_string\
(simple_request, env, str))
+
+/** Frees the http simple request.
+ @sa axis2_http_simple_request_ops#free */
#define AXIS2_HTTP_SIMPLE_REQUEST_FREE(simple_request, env) \
((simple_request)->ops->free(simple_request, 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