awsp.h

SyncML手册及其编程

/*************************************************************************/
/* module:          Communication Services, Abstract WSP API             */
/* file:            /src/xpt/all/awsp.h                                  */
/* target system:   all                                                  */
/* target OS:       all                                                  */
/*************************************************************************/

/*
 * Copyright Notice
 * Copyright (c) Ericsson, IBM, Lotus, Matsushita Communication 
 * Industrial Co., Ltd., Motorola, Nokia, Openwave Systems, Inc., 
 * Palm, Inc., Psion, Starfish Software, Symbian, Ltd. (2001).
 * All Rights Reserved.
 * Implementation of all or part of any Specification may require 
 * licenses under third party intellectual property rights, 
 * including without limitation, patent rights (such a third party 
 * may or may not be a Supporter). The Sponsors of the Specification 
 * are not responsible and shall not be held responsible in any 
 * manner for identifying or failing to identify any or all such 
 * third party intellectual property rights.
 * 
 * THIS DOCUMENT AND THE INFORMATION CONTAINED HEREIN ARE PROVIDED 
 * ON AN "AS IS" BASIS WITHOUT WARRANTY OF ANY KIND AND ERICSSON, IBM, 
 * LOTUS, MATSUSHITA COMMUNICATION INDUSTRIAL CO. LTD, MOTOROLA, 
 * NOKIA, PALM INC., PSION, STARFISH SOFTWARE AND ALL OTHER SYNCML 
 * SPONSORS DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 
 * BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 
 * HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
 * SHALL ERICSSON, IBM, LOTUS, MATSUSHITA COMMUNICATION INDUSTRIAL CO., 
 * LTD, MOTOROLA, NOKIA, PALM INC., PSION, STARFISH SOFTWARE OR ANY 
 * OTHER SYNCML SPONSOR BE LIABLE TO ANY PARTY FOR ANY LOSS OF 
 * PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF 
 * BUSINESS, OR FOR DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, 
 * PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND IN CONNECTION WITH 
 * THIS DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED 
 * OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 * 
 * The above notice and this paragraph must be included on all copies 
 * of this document that are made.
 * 
 */

/*
 * Version Label
 *
 * RELEASE ???? CANDIDATE ?
 * 05.06.2000
 */


/**
 * WSP protocol services, function prototypes and return codes
 *
 *
 */

#ifndef AWSP_H
#define AWSP_H
/* 
#ifdef _WIN32
 #ifdef WSP_EXPORTING
  #define WSP_EXPORT __declspec(dllexport)
 #else
  #define WSP_EXPORT __declspec(dllimport)
 #endif
#else
 #define WSP_EXPORT
#endif
*/
#define WSP_EXPORT

/*********************/
/* Required includes */
/*********************/
#include <xptdef.h>


#ifdef __cplusplus
extern "C" {
#endif


/*****************************/
/* Types and Data structures */
/*****************************/

/*
 *  Structure containing the capabilities that can be negotiated during WSP
 *  capability negotiation.
 */

typedef struct {
                  /* List of alternate addresses for current service user      */
/*             char *aliases[]; */
            char **aliases;
            int    aliasesSz;

                  /* Size of the largest transaction service data unit which
                   * may be sent to the client                                 */
   unsigned int   clientSDUsz;

                  /* Set of extended HTTP 1.1 methods supported                */
/*            char *extendedMethods[]; */
            char **extendedMethods;
            int    extendedMethodsSz;

                  /* Set of supported header code page names                   */
/*            char *headerCodePages[]; */
            char **headerCodePages;
            int    headerCodePagesSz;

                  /* Maximum number of active Method requests                  */
   unsigned int   maxOutstandingMethodRequests;

                  /* Maximum number of active Push requests                    */
   unsigned int   maxOutstandingPushRequests;

                  /* Set of optional WSP facilities available for use          */
/*            char *protocolOptions[]; */
            char **protocolOptions;
            int    protocolOptionsSz;

                  /* Size of the largest transaction service data unit that
                   * may be sent to the server                                 */
   unsigned int   serverSDUsz;

} awsp_Capabilities;

typedef void *awsp_ConnectionHandle;
typedef void *awsp_SessionHandle;

typedef enum {
   AWSP_TRUE           = 1,
   AWSP_FALSE          = 0
} awsp_BOOL;

typedef enum {
   AWSP_DEFAULT_BEARER = -1,
   AWSP_USSD           = 0,
   AWSP_CSD            = 1,
   AWSP_CDPD           = 2,
   AWSP_SMS            = 3,
   AWSP_PACKET         = 4,
   AWSP_FLEX_REFLEX    = 5,
   AWSP_GUTS_RDATA     = 6,
   AWSP_GPRS           = 7,
   AWSP_SDS            = 8
   } awsp_BEARER_TYPE;

typedef enum {
   AWSP_DEFAULT_ADDRESS   = -1,
   AWSP_IPV4              = 0,        // RFC 791, header format
   AWSP_IPV6              = 1,        // RFC 1884, header format
   AWSP_GSM_MSISDN        = 2,        // GSM 03.40, SMS address format
   AWSP_IS_136_MSISDN     = 3,        // IS-136, address format
   AWSP_IS_637_MSISDN     = 4,        // IS-637, address format
   AWSP_IDEN_MSISDN       = 5,        // Motorola doc #68P81095E55-A, iDen SMS address format
   AWSP_FLEX_MSISDN       = 6,        // Motorola doc #68P81139B01, FLEX address format
   AWSP_PHS_MSISDN        = 7,        //
   AWSP_GSM_SERVICE_CODE  = 8,        // GSM 02.90, GSM USSD service code address format
   AWSP_TETRA_ITSI        = 9,        // ETS 300 392-1, TETRA SDS address format
   AWSP_TETRA_MSISDN      = 10        // ETS 300 392-1, TETRA SDS address format
   } awsp_ADDRESS_TYPE;


/**************************/
/* Function return values */
/**************************/


/* I'm not sure what these should be yet...put in OK as placeholder */
typedef enum {
   AWSP_RC_OK               = 0,    // Successful request
   AWSP_RC_BUFFER_TOO_SMALL = 4     // Buffer size of output parameter is too small to
                                    // receive the requested data.
} awsp_Rc_t;


typedef enum {
   AWSP_PROTOERR     =  0xE0,    /* Protocol error, illegal PDU                */
   AWSP_DISCONNECT   =  0xE1,    /* Session has been disconnected              */
   AWSP_SUSPEND      =  0xE2,    /* Session has been suspended                 */
   AWSP_RESUME       =  0xE3,    /* Session has been resumed                   */
   AWSP_CONGESTION   =  0xE4,    /* Peer is congested, can't process SDU       */
   AWSP_CONNECTERR   =  0xE5,    /* Session connect failed                     */
   AWSP_MRUEXCEEDED  =  0xE6,    /* Max Receive Unit size exceeded             */
   AWSP_MOREXCEEDED  =  0xE7,    /* Max Outstanding Requests exceeded          */
   AWSP_PEERREQ      =  0xE8,    /* Peer request                               */
   AWSP_NETERR       =  0xE9,    /* Network error                              */
   AWSP_USERREQ      =  0xEA,    /* User request                               */
   AWSP_USERRFS      =  0xEB,    /* No specific cause, no retries              */
   AWSP_USERPND      =  0xEC,    /* Push cannot be delivered to destination    */
   AWSP_USERDCR      =  0xED,    /* Push discarded due to resource shortage    */
   AWSP_USERDCU      =  0xEE     /* Content type cannot be processed           */
} awsp_ReasonCode_t ;

typedef enum {                  // HTTP Status code
   AWSP_CONTINUE                 =  0x10, // 100
   AWSP_SWITCH_PROTOCOL          =  0x11, // 101
   AWSP_SUCCESS                  =  0x20, // 200
   AWSP_CREATED                  =  0x21, // 201
   AWSP_ACCEPTED                 =  0x22, // 202
   AWSP_NON_AUTHORITATIVE_ANSWER =  0x23, // 203
   AWSP_NO_CONTENT               =  0x24, // 204
   AWSP_RESET_CONTENT            =  0x25, // 205
   AWSP_PARTIAL_CONTENT          =  0x26, // 206
   AWSP_MULTIPLE_CHOICES         =  0x30, // 300
   AWSP_MOVED_PERMANENTLY        =  0x31, // 301
   AWSP_MOVED_TEMPORARILY        =  0x32, // 302
   AWSP_SEE_OTHER                =  0x33, // 303
   AWSP_NOT_MODIFIED             =  0x34, // 304
   AWSP_USE_PROXY                =  0x35, // 305
   AWSP_BAD_REQUEST              =  0x40, // 400
   AWSP_UNAUTHORIZED             =  0x41, // 401
   AWSP_PAYMENT_REQUIRED         =  0x42, // 402
   AWSP_FORBIDDEN                =  0x43, // 403
   AWSP_NOT_FOUND                =  0x44, // 404
   AWSP_METHOD_NOT_ALLOWED       =  0x45, // 405
   AWSP_NOT_ACCEPTABLE           =  0x46, // 406
   AWSP_PROXY_AUTH_REQUIRED      =  0x47, // 407
   AWSP_REQUEST_TIMEOUT          =  0x48, // 408
   AWSP_CONFLICT                 =  0x49, // 409
   AWSP_GONE                     =  0x4A, // 410
   AWSP_LENGTH_REQUIRED          =  0x4B, // 411
   AWSP_PRECONDITION_FAILED      =  0x4C, // 412
   AWSP_REQUEST_ENTITY_TOO_LARGE =  0x4D, // 413
   AWSP_REQUEST_URI_TOO_LARGE    =  0x4E, // 414
   AWSP_UNSUPPORTED_MEDIA_TYPE   =  0x4F, // 415
   AWSP_INTERNAL_SERVER_ERROR    =  0x60, // 500
   AWSP_NOT_IMPLEMENTED          =  0x61, // 501
   AWSP_BAD_GATEWAY              =  0x62, // 502
   AWSP_SERVICE_UNAVAILABLE      =  0x63, // 503
   AWSP_GATEWAY_TIMEOUT          =  0x64, // 504
   AWSP_HTTP_VERSION_UNSUPPORTED =  0x65  // 505
} awsp_StatusCode_t;

/*
 * Connect Request
 *    IN:   connHandle              (required)  A Handle for the initialized service
 *                                              Access Point - see initializeSAP().