# axis2_msg.h

Go to the documentation of this file.

    00001
    00002 /*
    00003  * Licensed to the Apache Software Foundation (ASF) under one or more
    00004  * contributor license agreements.  See the NOTICE file distributed with
    00005  * this work for additional information regarding copyright ownership.
    00006  * The ASF licenses this file to You under the Apache License, Version 2.0
    00007  * (the "License"); you may not use this file except in compliance with
    00008  * the License.  You may obtain a copy of the License at
    00009  *
    00010  *      http://www.apache.org/licenses/LICENSE-2.0
    00011  *
    00012  * Unless required by applicable law or agreed to in writing, software
    00013  * distributed under the License is distributed on an "AS IS" BASIS,
    00014  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    00015  * See the License for the specific language governing permissions and
    00016  * limitations under the License.
    00017  */
    00018
    00019 #ifndef AXIS2_MSG_H
    00020 #define AXIS2_MSG_H
    00021
    00036 #include <axutil_param_container.h>
    00037 #include <axis2_op.h>
    00038 #include <axutil_array_list.h>
    00039 #include <axis2_description.h>
    00040 #include <axis2_phase_meta.h>
    00041
    00043 #define AXIS2_MSG_IN            "in"
    00044
    00046 #define AXIS2_MSG_OUT           "out"
    00047
    00049 #define AXIS2_MSG_IN_FAULT      "InFaultMessage"
    00050
    00052 #define AXIS2_MSG_OUT_FAULT     "OutFaultMessage"
    00053
    00054 #ifdef __cplusplus
    00055 extern "C"
    00056 {
    00057 #endif
    00058
    00060     typedef struct axis2_msg axis2_msg_t;
    00061
    00067     AXIS2_EXTERN axis2_msg_t *AXIS2_CALL
    00068     axis2_msg_create(
    00069         const axutil_env_t * env);
    00070
    00077     AXIS2_EXTERN void AXIS2_CALL
    00078     axis2_msg_free(
    00079         axis2_msg_t * msg,
    00080         const axutil_env_t * env);
    00081
    00090     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00091     axis2_msg_add_param(
    00092         axis2_msg_t * msg,
    00093         const axutil_env_t * env,
    00094         axutil_param_t * param);
    00095
    00104     AXIS2_EXTERN axutil_param_t *AXIS2_CALL
    00105     axis2_msg_get_param(
    00106         const axis2_msg_t * msg,
    00107         const axutil_env_t * env,
    00108         const axis2_char_t * name);
    00109
    00117     AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
    00118     axis2_msg_get_all_params(
    00119         const axis2_msg_t * msg,
    00120         const axutil_env_t * env);
    00121
    00129     AXIS2_EXTERN axis2_bool_t AXIS2_CALL
    00130     axis2_msg_is_param_locked(
    00131         axis2_msg_t * msg,
    00132         const axutil_env_t * env,
    00133         const axis2_char_t * param_name);
    00134
    00143     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00144     axis2_msg_set_parent(
    00145         axis2_msg_t * msg,
    00146         const axutil_env_t * env,
    00147         axis2_op_t * op);
    00148
    00156     AXIS2_EXTERN axis2_op_t *AXIS2_CALL
    00157     axis2_msg_get_parent(
    00158         const axis2_msg_t * msg,
    00159         const axutil_env_t * env);
    00160
    00168     AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
    00169     axis2_msg_get_flow(
    00170         const axis2_msg_t * msg,
    00171         const axutil_env_t * env);
    00172
    00181     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00182     axis2_msg_set_flow(
    00183         axis2_msg_t * msg,
    00184         const axutil_env_t * env,
    00185         axutil_array_list_t * flow);
    00186
    00193     AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
    00194     axis2_msg_get_direction(
    00195         const axis2_msg_t * msg,
    00196         const axutil_env_t * env);
    00197
    00205     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00206     axis2_msg_set_direction(
    00207         axis2_msg_t * msg,
    00208         const axutil_env_t * env,
    00209         const axis2_char_t * direction);
    00210
    00217     AXIS2_EXTERN const axutil_qname_t *AXIS2_CALL
    00218     axis2_msg_get_element_qname(
    00219         const axis2_msg_t * msg,
    00220         const axutil_env_t * env);
    00221
    00230     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00231     axis2_msg_set_element_qname(
    00232         axis2_msg_t * msg,
    00233         const axutil_env_t * env,
    00234         const axutil_qname_t * element_qname);
    00235
    00242     AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
    00243     axis2_msg_get_name(
    00244         const axis2_msg_t * msg,
    00245         const axutil_env_t * env);
    00246
    00254     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00255     axis2_msg_set_name(
    00256         axis2_msg_t * msg,
    00257         const axutil_env_t * env,
    00258         const axis2_char_t * name);
    00259
    00266     AXIS2_EXTERN axis2_desc_t *AXIS2_CALL
    00267     axis2_msg_get_base(
    00268         const axis2_msg_t * msg,
    00269         const axutil_env_t * env);
    00270
    00278     AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL
    00279     axis2_msg_get_param_container(
    00280         const axis2_msg_t * msg,
    00281         const axutil_env_t * env);
    00282
    00289     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00290     axis2_msg_increment_ref(
    00291         axis2_msg_t * msg,
    00292         const axutil_env_t * env);
    00293
    00295 #ifdef __cplusplus
    00296 }
    00297 #endif
    00298 #endif                          /* AXIS2_MSG_H */