summaryrefslogtreecommitdiffstats
path: root/util/include/axutil_dll_desc.h
blob: 30f69f1c36389b3a9a8c4ef92b56a6175c04baa3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 AXUTIL_DLL_DESC_H
#define AXUTIL_DLL_DESC_H

/**
 * @file axutil_dll_desc.h
 * @brief Axis2 dll_desc interface
 */

#include <axutil_utils_defines.h>
#include <axutil_qname.h>
#include <axutil_error.h>
#include <axutil_utils.h>
#include <platforms/axutil_platform_auto_sense.h>

#ifdef __cplusplus
extern "C"
{
#endif

    /**
     * @defgroup axutil_dll_desc DLL description
     * @ingroup axis2_util
     * @{
     */

    typedef struct axutil_dll_desc axutil_dll_desc_t;

    typedef int(
        *CREATE_FUNCT)(
            void **inst,
            const axutil_env_t * env);

    typedef int(
        *DELETE_FUNCT)(
            void *inst,
            const axutil_env_t * env);

    typedef int axis2_dll_type_t;

    /**
     * creates dll_desc struct
     * @param qname qname, can be NULL
     */
    AXIS2_EXTERN axutil_dll_desc_t *AXIS2_CALL
    axutil_dll_desc_create(
        const axutil_env_t * env);

    AXIS2_EXTERN void AXIS2_CALL
    axutil_dll_desc_free_void_arg(
        void *dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN void AXIS2_CALL
    axutil_dll_desc_free(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    /**
     * Set path qualified platform specific dll name
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_name(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        axis2_char_t * name);

    /**
     * Return the path qualified platform specific dll name
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL
    axutil_dll_desc_get_name(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_type(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        axis2_dll_type_t type);

    AXIS2_EXTERN axis2_dll_type_t AXIS2_CALL
    axutil_dll_desc_get_type(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_load_options(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        int options);

    AXIS2_EXTERN int AXIS2_CALL
    axutil_dll_desc_get_load_options(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_dl_handler(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        AXIS2_DLHANDLER dl_handler);

    AXIS2_EXTERN AXIS2_DLHANDLER AXIS2_CALL
    axutil_dll_desc_get_dl_handler(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_create_funct(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        CREATE_FUNCT funct);

    AXIS2_EXTERN CREATE_FUNCT AXIS2_CALL
    axutil_dll_desc_get_create_funct(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_delete_funct(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        DELETE_FUNCT funct);

    AXIS2_EXTERN DELETE_FUNCT AXIS2_CALL
    axutil_dll_desc_get_delete_funct(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_timestamp(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        AXIS2_TIME_T timestamp);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axutil_dll_desc_set_error_code(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        axutil_error_codes_t error_code);

    AXIS2_EXTERN axutil_error_codes_t AXIS2_CALL

    axutil_dll_desc_get_error_code(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    AXIS2_EXTERN AXIS2_TIME_T AXIS2_CALL
    axutil_dll_desc_get_timestamp(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env);

    /**
    * This function will accept the library name without any platform
    * dependant prefixes or suffixes. It then prefix and suffix
    * platform dependant prefix and suffix macros to the original name
    * and return the platform specific dll name
    *
    * @param class_name
    * @return platform specific dll name
    */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL

    axutil_dll_desc_create_platform_specific_dll_name(
        axutil_dll_desc_t * dll_desc,
        const axutil_env_t * env,
        const axis2_char_t * class_name);

#ifdef __cplusplus
}
#endif

#endif                          /* AXIS2_DLL_DESC_H */