API Guide Home (Online version only) |

# HsPhoneIOTATypes.h File Reference

## Detailed Description

Header File for Phone Library API ---- IOTA CATEGORY.

NOTES: All implementations of the Handspring Phone Library support a common API. This API is broken up into various categories for easier management. This file defines the IOTA category. These API calls are used for features specific to IOTA operation on CDMA networks.

Definition in file HsPhoneIOTATypes.h.

Include dependency graph for HsPhoneIOTATypes.h:

Go to the source code of this file.

## Data Structures

- struct PhnIOTAReportType
- struct PhnIOTAPhnTlsRcUrlType
- struct PhnIOTAPhnNAISIPEdgeProxyType
- struct PhnIOTAPhnProxyAddrWdpType
- struct PhnIOTAPhnNAISIPCfgSvr
- struct PhnIOTAPhnNAIPPGType
- struct PhnIOTAPhnNAIIMStore
- struct PhnIOTAPhnNAISIPDataxchType
- struct PhnIOTAPhnNAISIPDatagwyType
- struct PhnIOTAPhnSIPRetryTimerType
- struct PhnIOTAPhnSIPRetryCntType
- struct PhnIOTAPhnDlsLockType
    Holds lock state of user's ability to change the download server URL address. More...
- struct PhnIOTAPhnHomepagetype
- struct PhnIOTAPhnTrustedDomainType
- struct tagIOTANotificationEventType

## Defines

- #define phnIOTAEvent 'Hita'
- #define isValidPhnIOTAItemType(i) ((i >= phnIOTAPhnBootNAIUrl) && (i <phnLibIOTAItemLast))
- #define kIOTACertMaxBlocks 132
- #define kIOTACertMaxBlockLen 127
- #define kIOTAProxyADDRMaxLen 20
- #define kIOTANaiSipEdgePxyMaxBlocks 4
- #define kIOTAPxyAddrWdpMaxBlocks 4
- #define kIOTAUrlMaxLen 128
- #define kIOTAUrlArrayMaxLen 65
- #define kIOTASipCfgBlocks 4
- #define kIOTANaiPpgMaxBlocks 4
- #define kIOTANaiIMStoreMaxBlocks 8
- #define kIOTANaiSipDataxchMaxBlocks 8
- #define kIOTANaiSipDdatgwyMaxBlocks 8
- #define kIOTAPhnSipRetryTimerMaxLen 9
- #define kIOTAPhnSipRetryTimerMaxBloacks 4
- #define kIOTAPhnSipRetryCntMaxLen 9
- #define kIOTAPhnSipRetryCntMaxBlocks 4
- #define kIOTATrustedDomainMaxLen 64

Text Header elements

- #define IOTAHeaderEscapeSeq "X-Wap-Application-Id: "
- #define IOTATextHeader "X-Wap-Application-Id: x-wap-application:iota.ua"
- #define IOTATextHeaderLength 47
- #define IOTATextHeaderTerminator '\n'

## Typedefs

- typedef UInt8 PhnIOTAItemType
- typedef tagIOTANotificationEventType IOTANotificationEventType

## Enumerations

- enum PhnIOTAStatus {
  phnIOTAUnknown = 0,
  phnIOTAStart,
  phnIOTAEnd,
  phnIOTACommit,
  phnIOTANAMSelect
  }
- enum PhnIOTAItemEnum {
  phnIOTAItemBootURL = 0x00,
  phnIOTAItemBootNAIURL = 0x01,
  phnIOTAItemTrustedDomain = 0x02,
  phnIOTAItemHomepageURL = 0x03,
  phnIOTAItemVendingURL = 0x04,
  phnIOTAItemDownloadServerURL = 0x05,
  phnIOTAItemDownloadServerLock = 0x06,
  phnIOTAItemConnectionTimeout = 0x07,
  phnIOTAItemPriWAPPushProxyGatewayURL = 0x08,
  phnIOTAItemSecWAPPushProxyGatewayURL = 0x09,
  phnIOTAItemPriProxyWDPAddress = 0x0A,
  phnIOTAItemSecProxyWDPAddress = 0x0B,
  phnIOTAItemPriSIPConfigServer = 0x0C,
  phnIOTAItemSecSIPConfigServer = 0x0D,
  phnIOTAItemPriSIPEdgeProxyGateway = 0x0E,
  phnIOTAItemSecSIPEdgeProxyGateway = 0x0F,
  phnIOTAItemPriDataExchangeURL = 0x10,
  phnIOTAItemSecDataExchangeURL = 0x11,
  phnIOTAItemPriDataGatewayURL = 0x12,
  phnIOTAItemSecDataGatewayURL = 0x13,
  phnIOTAItemPriSIPRetryTimer = 0x14,
  phnIOTAItemSecSIPRetryTimer = 0x15,
  phnIOTAItemPriSIPRetryCount = 0x16,
  phnIOTAItemSecSIPRetryCount = 0x17,
  phnIOTAItemPriIMMessageStore = 0x18,
  phnIOTAItemSecIMMessageStore = 0x19,
  phnIOTAItemRootCertificate1 = 0x40,
  phnIOTAItemRootCertificate2 = 0x41,
  phnIOTAItemRootCertificate3 = 0x42,
  phnIOTAItemRootCertificate4 = 0x43,
  phnIOTAItemPRLStorageSize = 0x50,
  phnIOTAItemSIPUsername = 0x51,
  phnIOTAItemSIPPassword = 0x52,
  phnIOTAItemLastNVItem = 0x60,
  phnIOTAItemUnknown = 0xFF
  }

## Define Documentation

#define IOTAHeaderEscapeSeq "X-Wap-Application-Id: "

start sequence of the header

Definition at line 76 of file HsPhoneIOTATypes.h.

#define IOTATextHeader "X-Wap-Application-Id: x-wap-application:iota.ua"

beginning of an IOTA header

Definition at line 77 of file HsPhoneIOTATypes.h.

#define IOTATextHeaderLength 47

length of the header

Definition at line 78 of file HsPhoneIOTATypes.h.

#define IOTATextHeaderTerminator '\n'

IOTA headers terminate at the line feed

Definition at line 80 of file HsPhoneIOTATypes.h.

#define isValidPhnIOTAItemType | ( | i |  | ) | ((i >= phnIOTAPhnBootNAIUrl) && (i <phnLibIOTAItemLast))

Definition at line 148 of file HsPhoneIOTATypes.h.

#define kIOTACertMaxBlockLen 127

Definition at line 154 of file HsPhoneIOTATypes.h.

#define kIOTACertMaxBlocks 132

Index should be < 12, starting from 0

Definition at line 153 of file HsPhoneIOTATypes.h.

#define kIOTANaiIMStoreMaxBlocks 8

Definition at line 218 of file HsPhoneIOTATypes.h.

#define kIOTANaiPpgMaxBlocks 4

Definition at line 206 of file HsPhoneIOTATypes.h.

#define kIOTANaiSipDataxchMaxBlocks 8

Definition at line 230 of file HsPhoneIOTATypes.h.

#define kIOTANaiSipDdatgwyMaxBlocks 8

Definition at line 242 of file HsPhoneIOTATypes.h.

#define kIOTANaiSipEdgePxyMaxBlocks 4

Definition at line 167 of file HsPhoneIOTATypes.h.

#define kIOTAPhnSipRetryCntMaxBlocks 4

Definition at line 270 of file HsPhoneIOTATypes.h.

#define kIOTAPhnSipRetryCntMaxLen 9

Definition at line 269 of file HsPhoneIOTATypes.h.

#define kIOTAPhnSipRetryTimerMaxBloacks 4

Definition at line 256 of file HsPhoneIOTATypes.h.

#define kIOTAPhnSipRetryTimerMaxLen 9

Definition at line 255 of file HsPhoneIOTATypes.h.

#define kIOTAProxyADDRMaxLen 20

Definition at line 166 of file HsPhoneIOTATypes.h.

#define kIOTAPxyAddrWdpMaxBlocks 4

Definition at line 179 of file HsPhoneIOTATypes.h.

#define kIOTASipCfgBlocks 4

Definition at line 194 of file HsPhoneIOTATypes.h.

#define kIOTATrustedDomainMaxLen 64

Definition at line 302 of file HsPhoneIOTATypes.h.

#define kIOTAUrlArrayMaxLen 65

Definition at line 192 of file HsPhoneIOTATypes.h.

#define kIOTAUrlMaxLen 128

Definition at line 191 of file HsPhoneIOTATypes.h.

#define phnIOTAEvent 'Hita'

Definition at line 83 of file HsPhoneIOTATypes.h.

## Typedef Documentation

typedef struct tagIOTANotificationEventType IOTANotificationEventType

Structure passed to the callbacks registered for incoming IOTA notifications

typedef UInt8 PhnIOTAItemType

let's hope it never gets beyond 256 items

Definition at line 86 of file HsPhoneIOTATypes.h.

## Enumeration Type Documentation

enum PhnIOTAItemEnum

Items stored in the radio NV (mostly for Sprint support). Some of these items may be used for other carriers in the future. Most of these items will be match the initial TIL implementation since we are focusing on Sprint support. We may be able to leverage the NVFlash support in the future and get away from the radio NV for most of these (unless we need UPST support).

Enumerator:

  phnIOTAItemBootURL | provisioning URL
  phnIOTAItemBootNAIURL | provisioning URL
  phnIOTAItemTrustedDomain | trusted domain for provisioning. All URLs must come from this
  phnIOTAItemHomepageURL | default browser homepage
  phnIOTAItemVendingURL | vending URL
  phnIOTAItemDownloadServerURL | download server URL
  phnIOTAItemDownloadServerLock | state of items downloaded from the download server (locked or not)
  phnIOTAItemConnectionTimeout | timeout for IOTA connections
  phnIOTAItemPriWAPPushProxyGatewayURL | Primary WAP push gateway
  phnIOTAItemSecWAPPushProxyGatewayURL | Secondary WAP push gateway
  phnIOTAItemPriProxyWDPAddress | WDP address. Translate to the NGG for profile 1
  phnIOTAItemSecProxyWDPAddress | WDP address. Translate to the NGG for profile 1
  phnIOTAItemPriSIPConfigServer | Primary Config server
  phnIOTAItemSecSIPConfigServer | Secondary Config server
  phnIOTAItemPriSIPEdgeProxyGateway | Primary SIP Proxy Edge gateway
  phnIOTAItemSecSIPEdgeProxyGateway | Secondary SIP Proxy Edge gateway
  phnIOTAItemPriDataExchangeURL | Primary Data Exchange URL
  phnIOTAItemSecDataExchangeURL | Secondary Data Exchange URL
  phnIOTAItemPriDataGatewayURL | Primary Data Gateway URL
  phnIOTAItemSecDataGatewayURL | Secondary Data Gateway URL
  phnIOTAItemPriSIPRetryTimer | Primary SIP Retry timer
  phnIOTAItemSecSIPRetryTimer | Secondary SIP Retry timer
  phnIOTAItemPriSIPRetryCount | Primary SIP Retry count
  phnIOTAItemSecSIPRetryCount | Secondary SIP Retry count
  phnIOTAItemPriIMMessageStore | Primary IM Message store
  phnIOTAItemSecIMMessageStore | Secondary IM Message store
  phnIOTAItemRootCertificate1 | Root certificate #1
  phnIOTAItemRootCertificate2 | Root certificate #2
  phnIOTAItemRootCertificate3 | Root certificate #3
  phnIOTAItemRootCertificate4 | Root certificate #4
  phnIOTAItemPRLStorageSize | max PRL size radio supports
  phnIOTAItemSIPUsername | Username for SIP accounts
  phnIOTAItemSIPPassword | password for SIP accounts
  phnIOTAItemLastNVItem | last IOTA NV Item
  phnIOTAItemUnknown | unknown item

Definition at line 95 of file HsPhoneIOTATypes.h.

    00096 {
    00097   phnIOTAItemBootURL                    = 0x00, /**< provisioning URL */
    00098   phnIOTAItemBootNAIURL                 = 0x01, /**< provisioning URL */
    00099   phnIOTAItemTrustedDomain              = 0x02, /**< trusted domain for provisioning.  All URLs must come from this */
    00100   phnIOTAItemHomepageURL                = 0x03, /**< default browser homepage */
    00101   phnIOTAItemVendingURL                 = 0x04, /**< vending URL */
    00102   phnIOTAItemDownloadServerURL          = 0x05, /**< download server URL */
    00103   phnIOTAItemDownloadServerLock         = 0x06, /**< state of items downloaded from the download server (locked or not) */
    00104   phnIOTAItemConnectionTimeout          = 0x07, /**< timeout for IOTA connections */
    00105   phnIOTAItemPriWAPPushProxyGatewayURL  = 0x08, /**< Primary WAP push gateway */
    00106   phnIOTAItemSecWAPPushProxyGatewayURL  = 0x09, /**< Secondary WAP push gateway */
    00107
    00108   // The following items are indexed for each PDP profile
    00109   // Sprint has 2 profiles, so these are indexed 0..1
    00110   phnIOTAItemPriProxyWDPAddress         = 0x0A, /**< WDP address. Translate to the NGG for profile 1 */
    00111   phnIOTAItemSecProxyWDPAddress         = 0x0B, /**< WDP address. Translate to the NGG for profile 1 */
    00112   phnIOTAItemPriSIPConfigServer         = 0x0C, /**< Primary Config server */
    00113   phnIOTAItemSecSIPConfigServer         = 0x0D, /**< Secondary Config server */
    00114   phnIOTAItemPriSIPEdgeProxyGateway     = 0x0E, /**< Primary SIP Proxy Edge gateway */
    00115   phnIOTAItemSecSIPEdgeProxyGateway     = 0x0F, /**< Secondary SIP Proxy Edge gateway */
    00116   phnIOTAItemPriDataExchangeURL         = 0x10, /**< Primary Data Exchange URL */
    00117   phnIOTAItemSecDataExchangeURL         = 0x11, /**< Secondary Data Exchange URL */
    00118   phnIOTAItemPriDataGatewayURL          = 0x12, /**< Primary Data Gateway URL */
    00119   phnIOTAItemSecDataGatewayURL          = 0x13, /**< Secondary Data Gateway URL */
    00120   phnIOTAItemPriSIPRetryTimer           = 0x14, /**< Primary SIP Retry timer */
    00121   phnIOTAItemSecSIPRetryTimer           = 0x15, /**< Secondary SIP Retry timer */
    00122   phnIOTAItemPriSIPRetryCount           = 0x16, /**< Primary SIP Retry count */
    00123   phnIOTAItemSecSIPRetryCount           = 0x17, /**< Secondary SIP Retry count */
    00124   phnIOTAItemPriIMMessageStore          = 0x18, /**< Primary IM Message store */
    00125   phnIOTAItemSecIMMessageStore          = 0x19, /**< Secondary IM Message store */
    00126
    00127
    00128   phnIOTAItemRootCertificate1           = 0x40, /**< Root certificate #1 */
    00129   phnIOTAItemRootCertificate2           = 0x41, /**< Root certificate #2 */
    00130   phnIOTAItemRootCertificate3           = 0x42, /**< Root certificate #3 */
    00131   phnIOTAItemRootCertificate4           = 0x43, /**< Root certificate #4 */
    00132
    00133   // Sprint items that used to be hard-coded in the IOTA app but now
    00134   // moved here, since different radios may possibly support different values.
    00135   phnIOTAItemPRLStorageSize             = 0x50, /**< max PRL size radio supports */
    00136
    00137   // items that are listed as Verizon requirements
    00138   phnIOTAItemSIPUsername                = 0x51, /**< Username for SIP accounts */
    00139   phnIOTAItemSIPPassword                = 0x52, /**< password for SIP accounts */
    00140
    00141   // last item
    00142   phnIOTAItemLastNVItem                 = 0x60, /**< last IOTA NV Item */
    00143
    00144   phnIOTAItemUnknown                    = 0xFF  /**< unknown item */
    00145 }

enum PhnIOTAStatus

Enumerator:

  phnIOTAUnknown |
  phnIOTAStart |
  phnIOTAEnd |
  phnIOTACommit |
  phnIOTANAMSelect |

Definition at line 45 of file HsPhoneIOTATypes.h.

    00046 {
    00047   phnIOTAUnknown = 0,       /**<        */
    00048     phnIOTAStart,       /**<        */
    00049     phnIOTAEnd,     /**<        */
    00050     phnIOTACommit,      /**<        */
    00051     phnIOTANAMSelect    /**<        */
    00052 }

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:07:20 2008 for Palm API Guide