API Guide Home (Online version only) |

# NetMasterLibTypes.h File Reference

## Detailed Description

This file contains public data types exported by the NetMaster Library.

Version:
  1.0

Date:
  01/31/2002

For usage model:

See also:
  NetMasterLibrary.h

Definition in file NetMasterLibTypes.h.

Go to the source code of this file.

## Data Structures

- struct NetMasterClientEventVPNConnInstallType
    Data block for netMasterClientEventVPNConnInstall. More...
- struct NetMasterClientEventInfoType
    This structure is passed as the 'detailsP' of the notification. More...

## Defines

- #define netMasterClientEventNotificationTypeID 'HnMe'
- #define netMasterClientCurrentEventVersion 1
- #define netMasterAnchorTimeoutDefault (-1)

NetMaster API Version Number
Current library API version number returned by NetMasterLibVersionGet()

- #define netMasterLibVersionMajor 0
- #define netMasterLibVersionMinor 4
- #define netMasterLibVersionBugFix 0

## Typedefs

- typedef UInt32 NetMasterAutoLoginType
- typedef UInt32 NetMasterNetIFShutDownOptionsType
- typedef UInt16 NetMasterClientEventEnum
- typedef UInt32 NetMasterNetLibOpenOptionsType
- typedef UInt32 NetMasterLoginPriorityEnum
- typedef UInt32 NetMasterDataContextIDType
- typedef UInt32 NetMasterDataSessionIDType

## Enumerations

- enum {
  netMasterAutoLoginWhenWirelessOn = 0x00000001UL,
  netMasterLoginNetGuardEnabled = 0x00000002UL,
  netMasterAutoLoginClearAll = 0xFFFFFFFFUL
  }
- enum {
  netMasterNetIFShutDownOptDismissPrgDialog = 0x00000001UL,
  netMasterNetIFShutDownOptCurrentOnly = 0x00000002UL,
  netMasterNetIFShutDownOptResetNetGuard = 0x00000004UL
  }
- enum {
  netMasterClientEventUnknown = 0,
  netMasterClientEventVPNConnInstall,
  netMasterClientEventLAST
  }
- enum {
  netMasterNetLibOpenOptAutoDismiss = 0x00000001UL,
  netMasterNetLibOpenOptBypassNetGuard = 0x00000002UL,
  netMasterNetLibOpenOptPrimaryProfileOnly = 0x00000004UL
  }
- enum {
  netMasterLoginPriorityDefault = 0,
  netMasterLoginPriorityLow = 1,
  netMasterLoginPriorityHigh = 2
  }

## Define Documentation

#define netMasterAnchorTimeoutDefault (-1)

Default value to pass as the anchorTimeoutSec parameter to NetMasterSCNetAttach

Definition at line 309 of file NetMasterLibTypes.h.

#define netMasterClientCurrentEventVersion 1

Increment this version # when adding fields to NetMasterClientEventInfoType, except when just adding a new event data pointer to eventData

Definition at line 193 of file NetMasterLibTypes.h.

#define netMasterClientEventNotificationTypeID 'HnMe'

The application that wishes to receive these notifications registers via Palm OS Notification Manager's SysNotifyRegister() for the event type netMasterClientEventNotificationTypeID to receive the events listed in NetMasterClientEventEnum. See Palm OS Notification Manager documentation for registration and notification handling details.

Definition at line 120 of file NetMasterLibTypes.h.

#define netMasterLibVersionBugFix 0

Definition at line 36 of file NetMasterLibTypes.h.

#define netMasterLibVersionMajor 0

Definition at line 34 of file NetMasterLibTypes.h.

#define netMasterLibVersionMinor 4

Definition at line 35 of file NetMasterLibTypes.h.

## Typedef Documentation

typedef UInt32 NetMasterAutoLoginType

TCP/IP Network Auto-login definitions used by NetMasterAutoLoginSettingGet() and NetMasterAutoLoginSettingSet()

Definition at line 50 of file NetMasterLibTypes.h.

typedef UInt16 NetMasterClientEventEnum

NetMaster library client event selector

Definition at line 124 of file NetMasterLibTypes.h.

typedef UInt32 NetMasterDataContextIDType

Data Context type used by NetMasterSCNetAttach, NetMasterSCNetDetach and friends.

Definition at line 317 of file NetMasterLibTypes.h.

typedef UInt32 NetMasterDataSessionIDType

Data Session type used by NetMasterSCSessionIDGetFromContext and friends.

Definition at line 324 of file NetMasterLibTypes.h.

typedef UInt32 NetMasterLoginPriorityEnum

Login priority values that may be passed to NetMasterSCNetAttach

Definition at line 276 of file NetMasterLibTypes.h.

typedef UInt32 NetMasterNetIFShutDownOptionsType

NetLib interface shutdown options for NetMasterNetInterfacesShutDown

Definition at line 74 of file NetMasterLibTypes.h.

typedef UInt32 NetMasterNetLibOpenOptionsType

Special NetLibOpenConfig options passed to NetMasterNetLibOpenWithOptions()

Definition at line 243 of file NetMasterLibTypes.h.

## Enumeration Type Documentation

anonymous enum

Enumerator:

  netMasterAutoLoginWhenWirelessOn | For CDMA 1xRTT: Automatically log in to the TCP/IP network when the wireless mode is turned on and network is acquired; For GSM GPRS: Attempt to attach when the radio is powered on (ideally a combined attach)
  netMasterLoginNetGuardEnabled | Prompt the user before connecting to the Internet; Also known as the "NetGuard" feature.
  netMasterAutoLoginClearAll |

Definition at line 51 of file NetMasterLibTypes.h.

    00052   {
    00053     /**
    00054      *  For CDMA 1xRTT: Automatically log in to the TCP/IP network when the
    00055      *  wireless mode is turned on and network is acquired;
    00056      *  For GSM GPRS: Attempt to attach when the radio is powered on (ideally
    00057      *  a combined attach)
    00058      */
    00059     // NOTE: Used by Handspring's Network Panel
    00060     netMasterAutoLoginWhenWirelessOn    = 0x00000001UL,
    00061
    00062     /**
    00063      * Prompt the user before connecting to the Internet;
    00064      * Also known as the "NetGuard" feature.
    00065      */
    00066     // NOTE: Used by Handspring's Network Panel
    00067     netMasterLoginNetGuardEnabled       = 0x00000002UL,
    00068
    00069     netMasterAutoLoginClearAll          = 0xFFFFFFFFUL
    00070   };

anonymous enum

Enumerator:

  netMasterNetIFShutDownOptDismissPrgDialog | If the Progress dialog is up, dismiss it even if it is in the error display state
  netMasterNetIFShutDownOptCurrentOnly | If set, and the session being connected at the moment has a fallback, this will allow the fallback to be processed (for example, when aborting GPRS logon, but allowing the fallback, if any, to take place)
  netMasterNetIFShutDownOptResetNetGuard | If set, will cause the cached NetGuard setting to be cleared: apps that Disconnect the network connection as the result of user request (such as Disconnect button or menu item), MUST set this flag -- this causes the system to put up the NetGuard prompt during a subsequent data network login, if dictated by the netMasterLoginNetGuardEnabled setting. If *not* set, will cause the cached NetGuard setting to be preserved.

Definition at line 75 of file NetMasterLibTypes.h.

    00076   {
    00077     /** If the Progress dialog is up, dismiss it even if it is
    00078      *  in the error display state
    00079      */
    00080     netMasterNetIFShutDownOptDismissPrgDialog   = 0x00000001UL,
    00081
    00082     /** If set, and the session being connected at the moment has
    00083      *  a fallback, this will allow the fallback to be processed (for example,
    00084      *  when aborting GPRS logon, but allowing the fallback, if any, to
    00085      *  take place)
    00086      */
    00087     netMasterNetIFShutDownOptCurrentOnly        = 0x00000002UL,
    00088
    00089
    00090     /** If set, will cause the cached NetGuard setting to be
    00091      *  cleared: apps that Disconnect the network connection as the
    00092      *  result of user request (such as Disconnect button or menu item),
    00093      *  MUST set this flag -- this causes the system to put up the
    00094      *  NetGuard prompt during a subsequent data network login,
    00095      *  if dictated by the netMasterLoginNetGuardEnabled setting.
    00096      *
    00097      *  If *not* set, will cause the cached NetGuard setting to
    00098      *  be preserved.
    00099      */
    00100     netMasterNetIFShutDownOptResetNetGuard      = 0x00000004UL
    00101
    00102
    00103   };

anonymous enum

Enumerator:

  netMasterClientEventUnknown |
  netMasterClientEventVPNConnInstall | Queries the VPN vendor to install its own connection profile name, if any; NetMaster library broadcasts this event to all registered clients from the context of the UI task when a client application calls NetLibOpen() or NetLibOpenConfig(). Parameter block: NetMasterClientEventInfoType:NetMasterClientEventVPNConnInstallType
  netMasterClientEventLAST |

Definition at line 125 of file NetMasterLibTypes.h.

    00126   {
    00127     netMasterClientEventUnknown     = 0,    // reserve 0
    00128
    00129     /** Queries the VPN vendor to install its own connection profile name,
    00130      *  if any; NetMaster library broadcasts this event to all registered
    00131      *  clients from the context of the UI task when a client application
    00132      *  calls NetLibOpen() or NetLibOpenConfig().
    00133      *  Parameter block:
    00134      *  NetMasterClientEventInfoType:NetMasterClientEventVPNConnInstallType
    00135      */
    00136     netMasterClientEventVPNConnInstall,
    00137
    00138
    00139
    00140
    00141     netMasterClientEventLAST
    00142   };

anonymous enum

Enumerator:

  netMasterNetLibOpenOptAutoDismiss | netMasterNetLibOpenOptAutoDismiss: If set, auto-dismiss the progress dialog if error occurs
  netMasterNetLibOpenOptBypassNetGuard | netMasterNetLibOpenOptBypassNetGuard: If set, bypass the NetGuard feature -- for use by IOTA service only!!! IMPORTANT: *not* available on systems before Palm OS 5.0
  netMasterNetLibOpenOptPrimaryProfileOnly | If this flag is set by the client, then the connection will be attempted only with the requested NetPref record, and the fallback network profile, if any, will be ignored. IMPORTANT: *not* available on systems before Palm OS 5.0

Definition at line 244 of file NetMasterLibTypes.h.

    00245   {
    00246     /** netMasterNetLibOpenOptAutoDismiss:
    00247      *
    00248      *  If set, auto-dismiss the progress dialog if error occurs
    00249      */
    00250     netMasterNetLibOpenOptAutoDismiss           = 0x00000001UL,
    00251
    00252
    00253     /** netMasterNetLibOpenOptBypassNetGuard:
    00254      *
    00255      *  If set, bypass the NetGuard feature -- for use by IOTA
    00256      *  service only!!!
    00257      *
    00258      *  IMPORTANT: *not* available on systems before Palm OS 5.0
    00259      */
    00260     //
    00261     // DOLATER \todo -- should this be in "protected" incs?
    00262     netMasterNetLibOpenOptBypassNetGuard        = 0x00000002UL,
    00263
    00264     /** If this flag is set by the client, then the connection will
    00265      *  be attempted only with the requested NetPref record, and the
    00266      *  fallback network profile, if any, will be ignored.
    00267      *
    00268      *  IMPORTANT: *not* available on systems before Palm OS 5.0
    00269      */
    00270     netMasterNetLibOpenOptPrimaryProfileOnly    = 0x00000004UL
    00271
    00272   };

anonymous enum

Enumerator:

  netMasterLoginPriorityDefault | The vast majority of background and foreground applications SHOULD ALWAYS use the Default login priority. This allows Data Session Control system software to optimize end-user experience on the device by following specific data session management rules requested by network operators.
  netMasterLoginPriorityLow | The Low login priority is the *least* disruptive to existing data sessions that were established with a different network service profile than the one that you're requesting.
  netMasterLoginPriorityHigh | The High login priority is the *most* disruptive to existing data sessions that were established with a different network service profile than the one that you're requesting. This will typically cause even active foreground data sessions to be torn down. This priority is reserved for *internal use only*, and should be avoided by other developers as its usage will typically break the data session management model of the device, resulting in poor end-user experience.

Definition at line 277 of file NetMasterLibTypes.h.

    00278   {
    00279     /** The vast majority of background and foreground applications SHOULD
    00280      *  ALWAYS use the Default login priority.  This allows Data Session
    00281      *  Control system software to optimize end-user experience
    00282      *  on the device by following specific data session
    00283      *  management rules requested by network operators.
    00284      */
    00285     netMasterLoginPriorityDefault           = 0,
    00286
    00287     /** The Low login priority is the *least* disruptive to existing data
    00288      *  sessions that were established with a different network service
    00289      *  profile than the one that you're requesting.
    00290      */
    00291     netMasterLoginPriorityLow               = 1,
    00292
    00293     /** The High login priority is the *most* disruptive to existing data
    00294      *  sessions that were established with a different network service
    00295      *  profile than the one that you're requesting.  This will typically
    00296      *  cause even active foreground data sessions to be torn down. This
    00297      *  priority is reserved for *internal use only*, and should be avoided
    00298      *  by other developers as its usage will typically break the data
    00299      *  session management model of the device, resulting in poor end-user
    00300      *  experience.
    00301      */
    00302     netMasterLoginPriorityHigh              = 2
    00303
    00304   };

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