OpenSOAP: Envelope.h Source File

00001 /* -*- mode: c++; -*-
00002  *-----------------------------------------------------------------------------
00003  * $RCSfile: Envelope.h,v $
00004  *
00005  * See Copyright for the status of this software.
00006  *
00007  * The OpenSOAP Project
00008  * http://opensoap.jp/
00009  *-----------------------------------------------------------------------------
00010  */
00369 #ifndef OpenSOAP_Envelope_H
00370 #define OpenSOAP_Envelope_H
00371 
00372 #include <OpenSOAP/Block.h>
00373 #include <OpenSOAP/ByteArray.h>
00374 #include <OpenSOAP/String.h>
00375 
00376 #include <stdlib.h>
00377 
00378 #ifdef __cplusplus
00379 extern "C" {
00380 #endif /* __cplusplus */
00381 
00382     typedef struct tagOpenSOAPEnvelope OpenSOAPEnvelope;
00383 
00384     typedef OpenSOAPEnvelope    *OpenSOAPEnvelopePtr;
00385 
00386     int
00387     OPENSOAP_API
00388     OpenSOAPEnvelopeCreate(/* [out] */ OpenSOAPEnvelopePtr *soap_env);
00389 
00390     int
00391     OPENSOAP_API
00392     OpenSOAPEnvelopeCreateMB(/* [in]  */ const char *soapVer,
00393                              /* [in]  */ const char *envPrefix,
00394                              /* [out] */ OpenSOAPEnvelopePtr *soapEnv);
00395 
00396     int
00397     OPENSOAP_API
00398     OpenSOAPEnvelopeCreateWC(/* [in]  */ const wchar_t *soapVer,
00399                              /* [in]  */ const wchar_t *envPrefix,
00400                              /* [out] */ OpenSOAPEnvelopePtr *soapEnv);
00401 
00402     int
00403     OPENSOAP_API
00404     OpenSOAPEnvelopeCreateString(/* [in]  */ OpenSOAPStringPtr soapVer,
00405                                  /* [in]  */ OpenSOAPStringPtr envPrefix,
00406                                  /* [out] */ OpenSOAPEnvelopePtr *soapEnv);
00407 
00408     int
00409     OPENSOAP_API
00410     OpenSOAPEnvelopeCreateFaultMB(/* [in]  */ const char *soapVer,
00411                                   /* [in]  */ const char *envPrefix,
00412                                   /* [in]  */ const char *faultCode,
00413                                   /* [in]  */ const char *faultString,
00414                                   /* [out] */ OpenSOAPBlockPtr *faultBlock,
00415                                   /* [out] */ OpenSOAPEnvelopePtr *soapEnv);
00416 
00417     int
00418     OPENSOAP_API
00419     OpenSOAPEnvelopeCreateFaultWC(/* [in]  */ const wchar_t *soapVer,
00420                                   /* [in]  */ const wchar_t *envPrefix,
00421                                   /* [in]  */ const wchar_t *faultCode,
00422                                   /* [in]  */ const wchar_t *faultString,
00423                                   /* [out] */ OpenSOAPBlockPtr *faultBlock,
00424                                   /* [out] */ OpenSOAPEnvelopePtr *soapEnv);
00425 
00426     int
00427     OPENSOAP_API
00428     OpenSOAPEnvelopeCreateCharEncoding(/* [in]  */ const char *chEnc,
00429                                        /* [in]  */ OpenSOAPByteArrayPtr b_ary,
00430                                        /* [out] */ OpenSOAPEnvelopePtr *soapEnv);
00431 
00432     int
00433     OPENSOAP_API
00434     OpenSOAPEnvelopeRetain(/* [in, out] */ OpenSOAPEnvelopePtr soapEnv);
00435 
00436     int
00437     OPENSOAP_API
00438     OpenSOAPEnvelopeRelease(/* [in, out] */ OpenSOAPEnvelopePtr soapEnv);
00439 
00440     int
00441     OPENSOAP_API
00442     OpenSOAPEnvelopeAddHeaderBlockMB(/* [out]  */ OpenSOAPEnvelopePtr soapEnv,
00443                                      /* [in]  */ const char *block_name,
00444                                      /* [out] */ OpenSOAPBlockPtr *h_block);
00445 
00446     int
00447     OPENSOAP_API
00448     OpenSOAPEnvelopeAddHeaderBlockWC(/* [out]  */ OpenSOAPEnvelopePtr soapEnv,
00449                                      /* [in]  */ const wchar_t *block_name,
00450                                      /* [out] */ OpenSOAPBlockPtr *h_block);
00451 
00452     int
00453     OPENSOAP_API
00454     OpenSOAPEnvelopeGetNextHeaderBlock(/* [in] */ OpenSOAPEnvelopePtr soap_env,
00455                                        /* [in, out] */ OpenSOAPBlockPtr *h_block);
00456 
00457     int
00458     OPENSOAP_API
00459     OpenSOAPEnvelopeGetHeaderBlockMB(/* [in]  */ OpenSOAPEnvelopePtr soap_env,
00460                                      /* [in]  */ const char *block_name,
00461                                      /* [out] */ OpenSOAPBlockPtr *h_block);
00462 
00463     int
00464     OPENSOAP_API
00465     OpenSOAPEnvelopeGetHeaderBlockWC(/* [in]  */ OpenSOAPEnvelopePtr soap_env,
00466                                      /* [in]  */ const wchar_t *block_name,
00467                                      /* [out] */ OpenSOAPBlockPtr *h_block);
00468 
00469     int
00470     OPENSOAP_API
00471     OpenSOAPEnvelopeAddBodyBlockMB(/* [out]  */ OpenSOAPEnvelopePtr soap_env,
00472                                    /* [in]  */ const char *block_name,
00473                                    /* [out] */ OpenSOAPBlockPtr *b_block);
00474 
00475     int
00476     OPENSOAP_API
00477     OpenSOAPEnvelopeAddBodyBlockWC(/* [out]  */ OpenSOAPEnvelopePtr soap_env,
00478                                    /* [in]  */ const wchar_t *block_name,
00479                                    /* [out] */ OpenSOAPBlockPtr *b_block);
00480 
00481     int
00482     OPENSOAP_API
00483     OpenSOAPEnvelopeGetNextBodyBlock(/* [in]  */ OpenSOAPEnvelopePtr soap_env,
00484                                      /* [in, out] */ OpenSOAPBlockPtr *b_block);
00485 
00486     int
00487     OPENSOAP_API
00488     OpenSOAPEnvelopeGetBodyBlockMB(/* [in]  */ OpenSOAPEnvelopePtr soap_env,
00489                                    /* [in]  */ const char *block_name,
00490                                    /* [out] */ OpenSOAPBlockPtr *b_block);
00491 
00492     int
00493     OPENSOAP_API
00494     OpenSOAPEnvelopeGetBodyBlockWC(/* [in]  */ OpenSOAPEnvelopePtr soap_env,
00495                                    /* [in]  */ const wchar_t *block_name,
00496                                    /* [out] */ OpenSOAPBlockPtr *b_block);
00497 
00498     int
00499     OPENSOAP_API
00500     OpenSOAPEnvelopeGetCharEncodingString(/* [in]  */ OpenSOAPEnvelopePtr soapEnv,
00501                                           /* [in]  */ const char *chEnc,
00502                                           /* [out] */ OpenSOAPByteArrayPtr b_ary);
00503     
00504     int
00505     OPENSOAP_API
00506     OpenSOAPEnvelopeGetHeaderCharEncodingString(/* [in]  */ OpenSOAPEnvelopePtr soap_env,
00507                                                 /* [in]  */ const char *ch_enc,
00508                                                 /* [out] */ OpenSOAPByteArrayPtr  b_ary);
00509 
00510     int
00511     OPENSOAP_API
00512     OpenSOAPEnvelopeGetBodyCharEncodingString(/* [in]  */ OpenSOAPEnvelopePtr soap_env,
00513                                               /* [in]  */ const char *ch_enc,
00514                                               /* [out] */ OpenSOAPByteArrayPtr b_ary);
00515 
00516     int
00517     OPENSOAP_API
00518     OpenSOAPEnvelopeAddFaultString(/* [out] */ OpenSOAPEnvelopePtr soapEnv,
00519                                    /* [in]  */ OpenSOAPStringPtr faultCode,
00520                                    /* [in]  */ OpenSOAPStringPtr faultString,
00521                                    /* [in]  */ int isValueDup,
00522                                    /* [out] */ OpenSOAPBlockPtr *faultBlock);
00523 
00524     int
00525     OPENSOAP_API
00526     OpenSOAPEnvelopeGetActorNameString(/* [in]  */ OpenSOAPEnvelopePtr soapEnv,
00527                                        /* [out] */ OpenSOAPStringPtr *actorName);
00528 
00529     int
00530     OPENSOAP_API
00531     OpenSOAPEnvelopeGetActorNextString(/* [in]  */ OpenSOAPEnvelopePtr soapEnv,
00532                                        /* [out] */ OpenSOAPStringPtr *actorNext);
00533 
00534 #ifdef __cplusplus
00535 }
00536 #endif /* __cplusplus */
00537 
00538 #endif /* OpenSOAP_Envelope_H */