OpenSOAP: ByteArray.h Source File

00001 /* -*- mode: c++; -*-
00002  *-----------------------------------------------------------------------------
00003  * $RCSfile: ByteArray.h,v $
00004  *
00005  * See Copyright for the status of this software.
00006  *
00007  * The OpenSOAP Project
00008  * http://opensoap.jp/
00009  *-----------------------------------------------------------------------------
00010  */
00221 #ifndef OpenSOAP_ByteArray_H
00222 #define OpenSOAP_ByteArray_H
00223 
00224 #include <stdlib.h>
00225 #include <sys/types.h>
00226 
00227 #include <OpenSOAP/Defines.h>
00228 #include <OpenSOAP/ErrorCode.h>
00229 
00230 #ifdef __cplusplus
00231 extern "C" {
00232 #endif /* __cplusplus */
00233 
00234     typedef struct tagOpenSOAPByteArray OpenSOAPByteArray;
00235 
00236     typedef OpenSOAPByteArray    *OpenSOAPByteArrayPtr;
00237 
00238     int
00239     OPENSOAP_API
00240     OpenSOAPByteArrayCreate(OpenSOAPByteArrayPtr * /* [out] */ b_ary);
00241 
00242     int
00243     OPENSOAP_API
00244     OpenSOAPByteArrayCreateWithData(const unsigned char * /* [in] */ data,
00245                                     size_t /* [in] */ sz,
00246                                     OpenSOAPByteArrayPtr * /* [out] */ b_ary);
00247 
00248     #define OpenSOAPByteArrayCreateWithSize(sz, b_ary) OpenSOAPByteArrayCreateWithData(0, (sz), (b_ary))
00249 
00250     int
00251     OPENSOAP_API
00252     OpenSOAPByteArrayAppendRef(OpenSOAPByteArrayPtr /* [in] */ b_ary);
00253 
00254     int
00255     OPENSOAP_API
00256     OpenSOAPByteArrayRelease(OpenSOAPByteArrayPtr /* [in] */ b_ary);
00257 
00258     int
00259     OPENSOAP_API
00260     OpenSOAPByteArrayGetSize(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00261                              size_t * /* [out] */ sz);
00262 
00263     int
00264     OPENSOAP_API
00265     OpenSOAPByteArrayBeginConst(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00266                                 const unsigned char ** /* [out] */beg);
00267     
00268     int
00269     OPENSOAP_API
00270     OpenSOAPByteArrayEndConst(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00271                               const unsigned char ** /* [out] */ed);
00272     
00273     int
00274     OPENSOAP_API
00275     OpenSOAPByteArrayGetBeginSizeConst(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00276                                        const unsigned char ** /* [out] */ beg,
00277                                        size_t * /* [out] */ sz);
00278 
00279     int
00280     OPENSOAP_API
00281     OpenSOAPByteArrayGetBeginEndConst(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00282                                       const unsigned char ** /* [out] */ beg,
00283                                       const unsigned char ** /* [out] */ ed);
00284     
00285     int
00286     OPENSOAP_API
00287     OpenSOAPByteArrayBegin(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00288                            unsigned char ** /* [out] */beg);
00289     
00290     int
00291     OPENSOAP_API
00292     OpenSOAPByteArrayEnd(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00293                          unsigned char ** /* [out] */ed);
00294 
00295     int
00296     OPENSOAP_API
00297     OpenSOAPByteArrayGetBeginSize(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00298                                   unsigned char ** /* [out] */ beg,
00299                                   size_t * /* [out] */ sz);
00300 
00301     int
00302     OPENSOAP_API
00303     OpenSOAPByteArrayGetBeginEnd(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00304                                  unsigned char ** /* [out] */ beg,
00305                                  unsigned char ** /* [out] */ ed);
00306     
00307     int
00308     OPENSOAP_API
00309     OpenSOAPByteArrayClear(OpenSOAPByteArrayPtr /* [in] */ b_ary);
00310 
00311     int
00312     OPENSOAP_API
00313     OpenSOAPByteArraySetData(OpenSOAPByteArrayPtr /* [in, out] */ b_ary,
00314                              const unsigned char * /* [in] */ data,
00315                              size_t /* [in] */ sz);
00316     
00317     int
00318     OPENSOAP_API
00319     OpenSOAPByteArrayAppend(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00320                             const unsigned char *dat,
00321                             size_t       dat_len);
00322 
00323     int
00324     OPENSOAP_API
00325     OpenSOAPByteArrayResize(OpenSOAPByteArrayPtr /* [in, out] */ b_ary,
00326                             size_t       /* [in] */ new_size);
00327 
00328     int
00329     OPENSOAP_API
00330     OpenSOAPByteArrayDuplicate(OpenSOAPByteArrayPtr /* [in] */ b_ary,
00331                                OpenSOAPByteArrayPtr * /* [out] */ dup_b_ary);
00332 
00333 #ifdef __cplusplus
00334 }
00335 #endif /* __cplusplus */
00336 
00337 #endif /* OpenSOAP_ByteArray_H */