Cisco BBSM 5.1 SDK Developer Guide.
Index

Table Of Contents

A - B - C - D - E - F - G - I - M - N - O - P - Q - R - S - T - U - W -

Index

A

AccessCode page set     2-9

access policies

overview     3-1

samples     3-3

Access Code     3-4

Block     3-4

Daily     3-5

Minute     3-7

RADIUS     3-7

Subscription     3-9

testing     3-16

AccessPolicyAccessCodeASP.WebInterface object     2-48

SendActivateSession method     2-48

WriteDuplicateSessions method     2-50

AccessPolicyBlockASP.WebInterface object

SendActivateSession method     2-51

AccessPolicyDailyASP.WebInterface object     2-52

FormatTime method     2-53

GetTotalSpent method     2-54

GetWelcomeBack method     2-54

SendActivateSession (Daily) method     2-55

AccessPolicyMinuteASP.WebInterface object

SendActivateSession method     2-58

access policy modules, overview     3-1

AccessPolicyRADIUSASP.WebInterface object     2-59

CalculateUserTotals method     2-60

GetTotalCharge method     2-61

GetTotalSeconds method     2-62

GetUserName method     2-63

SendActivateSession method     2-64

AccessPolicySubscriptionASP.WebInterface object     2-65

GetSubscriptionEnd method     2-66

IsExpired method     2-66

SendActivateSession method     2-67

Subscribe method     2-68

accounting policies

classes     4-10

CAccountingCallback     4-16

CAccountingPolicy     4-10

CAccountingResponse     4-23

overview     4-1

samples     4-1

CMSCreditCard     4-2

CruiseLine     4-2

Hotel     4-3

ICSCreditCard     4-3

Null     4-4

accounting policy modules, overview     4-1

AppWizards

Access Policy     3-10

AccessPolicy ASP     3-10

Accounting Policy     4-4

Cisco BBSM Ethernet Network Element Module     6-5

PMS Protocol Module     5-15

AtDial database schemas     9-1

B

backing up page sets     2-44

BandwidthKbpsToSpring function     2-85

BandwidthManager, using in page sets     2-5

BlockICS page set     2-10

building

AccessPolicyBlockASP project     7-3

AccessPolicyBlock project     7-2

AccessPolicyNull project     7-3

PMSProtocolXiox project     7-3

TUTDULiteSwitch project     7-3

Building Broadband Service Director     2-44

C

CAccessPolicy class     3-20

~CAccessPolicy method     3-23

AccessPolicyRequest method     3-20

ActivateSession method     3-22

CAccessPolicy method     3-23

CallConfigure method     3-23

CleanUp method     3-24

CleanUpSession method     3-24

Configure method     3-25

DeactivateSession method     3-25

GetAccessPolicy method     3-26

GetClientIP method     3-26

GetName method     3-27

LoadAccessPolicies method     3-27

MonitorSession method     3-27

ProcessAccountingResponse method     3-28

ResponseWrite method     3-29

SendMsg method     3-29

CAccountingCallback class     4-16

~CAccountingCallback method     4-16

CAccountingCallback method     4-16

LogAccountingError method     4-17

LogAuthorizeRequest method     4-18

LogEvent method     4-19

LogSaleComplete method     4-19

LogSaleEnqueued method     4-20

ProcessResponse method     4-21

CAccountingPolicy class     4-10

~CAccountingPolicy method     4-13

Authorize method     4-11

AuthorizeSale method     4-12

CAccountingPolicy method     4-13

CleanUp method     4-13

GetAccountingPolicy method     4-14

GetName method     4-14

GetStoreAccountingInfo method     4-14

LoadAccountingPolicies method     4-14

Sale method     4-15

UpdateAccountingInfo method     4-15

CAccountingResponse class     4-23

~CAccountingResponse method     4-24

CAccountingResponse method     4-24

GetAccountingInfo method     4-25

GetClientIP method     4-25

GetIsSale method     4-26

GetResponse method     4-26

GetResponseString method     4-26, 4-27

GetTransactionAmount method     4-27

certificate

downloading from the certificate authority     D-24

granting     D-23

installing     D-28

certificate authority

downloading the certificate from     D-24

installing     D-1

modifying the settings     D-7

sending certificate request to     D-18

certificate request

generating     D-10

sending to certificate authority     D-18

CEtherStack class     6-13

~CEtherStack() method     6-15

AddDefaultPortmap method     6-16

AddPortmapEntry method     6-18

AddPortmap method     6-17

CEtherStack method     6-15

CreateNew method     6-20

DeletePortmap method     6-21

FindPortFromIP method     6-22

FindPortFromMac method     6-22

FormatPortID method     6-23

GetAdminStatus method     6-23

GetAgingTime method     6-24

GetClientPortCount method     6-24

GetDisconnectTimeAdjustment method     6-25

GetMacFromIP method     6-25

GetOperStatusFromPort method     6-26

GetOperStatus method     6-26

GetSwitchesPerStack method     6-27

GetSysObjectID method     6-27

GetTotalPortCount method     6-27

GetUsageCounts method     6-27

IsPortConnected method     6-28

IsSwitchConnected method     6-29

MACToOid method     6-30

MACtoUnpacked method     6-30

MaptoMIB method     6-30

MIBtoMap method     6-31

ParsePortID method     6-31

SetAdminStatus method     6-32

SetAgingTime method     6-33

SupportsDefaultPortmap method     6-33

SupportsPortmapUpdate method     6-33

UnpackedMACToOid method     6-34

UnpackedToMAC method     6-34

classes

CAccessPolicy     3-20

CAccountingCallback     4-16

CAccountingPolicy     4-10

CAccountingResponse     4-23

CEtherStack     6-13

CModemStack     6-34

CPMSFeedback     5-27

CPMSProtocol     5-21

CSNMPAgent     6-38

CModemStack class     6-34

~CModemStack() method     6-35

AddDefaultPortmap method     6-36

CModemStack method     6-35

GetClientPortCount method     6-37

GetDisconnectTimeAdjustment method     6-37

SupportsDefaultPortmap method     6-37

CommonSubroutines.asp

functions

BandwidthKbpsToSpring     2-85

FormatDuration     2-85

FormatPrice     2-86

GenerateComboBox     2-86

MDSubGenerateComboBox     2-87

using in page sets     2-7

CPMSFeedback class     5-27

~CPMSFeedback method     5-29

AddDataString method     5-28

Complete method     5-29

CPMSFeedback method     5-29

DeInitializeCommPort method     5-29

ErrorMessage method     5-30

InitializeCommConfig method     5-30

InitializeCommPort method     5-30

KillTimer method     5-31

ProcessCommPortData method     5-31

SaveCommSettingsToRegistry method     5-31

SetMainWindow method     5-32

SetTimer method     5-32

Write method     5-32, 5-33

CPMSProtocol class     5-21

~CPMSProtocol method     5-22

BuildAthdmnRegistryMap method     5-21

CPMSProtocol     5-22

DoModalConfigDialog method     5-22

GenerateDisplayString method     5-22, 5-23

GetAthdmnRegistryData method     5-23

GetProtocolName method     5-23

GetSequenceNumber method     5-24

ProcessCommPortData method     5-24

ProcessSend method     5-25

ProcessTimer method     5-26

SetAthdmnRegistryData method     5-26

SetPMSRole method     5-26

TweakRoomNumber method     5-27

creating

access policy modules (DLLs)     3-1, 3-10

accounting policy modules (DLLs)     4-1, 4-4

MFC extension DLLs for network element modules     6-5

network element modules     6-5

page sets     2-1, 2-43

PDA page sets     G-1

PMS protocol modules (DLLs)     5-1

CruiseLine page set     2-10

CruiseLineValidationASP.WebInterface object     2-70

IsValidCreditCard method     2-70

IsValidFolioNumber method     2-71

CSNMPAgent class     6-38

CloseSession method     6-38

CSNMPAgent method     6-38

GetCounter method     6-39

GetInteger method     6-39

GetIPAddress method     6-40

GetNextInteger method     6-40

GetNextIPAddress method     6-40

GetNextObjectIdentifier method     6-41

GetNextOctetString method     6-41

GetObjectIdentifier method     6-42

GetOctetString method     6-42

OpenSession method     6-43

SetInteger method     6-43

SetIPAddress method     6-44

SetOctetString method     6-44

StartWalk method     6-45

customizing

iport_tools.asp     2-5

page sets     2-41

customizing Microsoft Visual Studio     B-3

D

DailyHotel page set     2-15

DailyICSClear page set     2-19

DailyICS page set     2-19

database schemas, AtDial     9-1

debugging

standalone     8-1

using trace feature     8-3

E

error messages     2-40, 2-47

F

file permissions     2-44

FormatDuration function     2-85

FormatPrice function     2-86

G

GenerateComboBox function     2-86

generating a certificate request     D-10

I

installing

BBSM SDK     C-1

certificate     D-28

certificate authorities     D-1

Microsoft platform SDK     B-3

Microsoft Visual Studio 6.0     B-1

MSDN     B-2

Visual Studio 6.0 Service Pack 4     B-5

iport_tools.asp, using in page sets     2-5

M

MDSubGenerateComboBox function     2-87

MeetingRoom page set     2-19

Mega page set     2-21

messages

AccessPolicyRequest     3-19

ActivateSession     3-17

used to create access policies     3-17

methods

~CAccountingCallback     4-16

BandwidthBoost     2-72

CAccessPolicy class

~CAccessPolicy     3-23

AccessPolicyRequest     3-20

ActivateSession     3-22

CAccessPolicy     3-23

CallConfigure     3-23

CleanUp     3-24

CleanUpSession     3-24

Configure     3-25

DeactivateSession     3-25

GetAccessPolicy     3-26

GetClientIP     3-26

GetName     3-27

LoadAccessPolicies     3-27

MonitorSession     3-27

ProcessAccountingResponse     3-28

ResponseWrite     3-29

SendMsg     3-29

CAccountingCallback

CAccountingCallback     4-16

LogAccountingError     4-17

LogAuthorizeRequest     4-18

LogEvent     4-19

LogSaleComplete     4-19

LogSaleEnqueued     4-20

ProcessResponse     4-21

CAccountingPolicy

~CAccountingPolicy     4-13

Authorize     4-11

AuthorizeSale     4-12

CAccountingPolicy     4-13

CleanUp     4-13

GetAccountingPolicy     4-14

GetName     4-14

GetStoreAccountingInfo     4-14

LoadAccountingPolicies     4-14

Sale     4-15

UpdateAccountingInfo     4-15

CAccountingResponse

~CAccountingResponse     4-24

CAccountingResponse     4-24

GetAccountingInfo     4-25

GetClientIP     4-25

GetIsSale     4-26

GetResponse     4-26

GetResponseString     4-26, 4-27

GetTransactionAmount     4-27

CalculateUserTotals     2-60

CEtherStack

~CEtherStack()     6-15

AddDefaultPortmap     6-16

AddPortmap     6-17

AddPortmapEntry     6-18

CEtherStack     6-15

CreateNew     6-20

DeletePortmap     6-21

FindPortFromIP     6-22

FindPortFromMac     6-22

FormatPortID     6-23

GetAdminStatus     6-23

GetAgingTime     6-24

GetClientPortCount     6-24

GetDisconnectTimeAdjustment     6-25

GetMacFromIP     6-25

GetOperStatus     6-26

GetOperStatusFromPort     6-26

GetSwitchesPerStack     6-27

GetSysObjectID     6-27

GetTotalPortCount     6-27

GetUsageCounts     6-27

IsPortConnected     6-28

IsSwitchConnected     6-29

MACToOid     6-30

MACtoUnpacked     6-30

MaptoMIB     6-30

MIBtoMap     6-31

ParsePortID     6-31

SetAdminStatus     6-32

SetAgingTime     6-33

SupportsDefaultPortmap     6-33

SupportsPortmapUpdate     6-33

UnpackedMACToOid     6-34

UnpackedToMAC     6-34

CheckPage     2-73

ClientBye     2-73

CModemStack

~CModemStack     6-35

AddDefaultPortmap     6-36

CModemStack     6-35

GetClientPortCount     6-37

GetDisconnectTimeAdjustment     6-37

SupportsDefaultPortmap     6-37

CPMSFeedback class

~CPMSFeedback     5-29

AddDataString     5-28

Complete     5-29

CPMSFeedback     5-29

DeInitializeCommPort     5-29

ErrorMessage     5-30

InitializeCommConfig     5-30

InitializeCommPort     5-30

KillTimer     5-31

ProcessCommPortData     5-31

SaveCommSettingsToRegistry     5-31

SetMainWindow     5-32

SetTimer     5-32

Write     5-32, 5-33

CPMSProtocol class

~CPMSProtocol     5-22

BuildAthdmnRegistryMap     5-21

CPMSProtocol     5-22

DoModalConfigDialog     5-22

GenerateDisplayString     5-22, 5-23

GetAthdmnRegistryData     5-23

GetProtocolName     5-23

GetSequenceNumber     5-24

ProcessCommPortData     5-24

ProcessSend     5-25

ProcessTimer     5-26

SetAthdmnRegistryData     5-26

SetPMSRole     5-26

TweakRoomNumber     5-27

CSNMPAgent

CloseSession     6-38

CSNMPAgent     6-38

GetCounter     6-39

GetInteger     6-39

GetIPAddress     6-40

GetNextInteger     6-40

GetNextIPAddress     6-40

GetNextObjectIdentifier     6-41

GetNextOctetString     6-41

GetObjectIdentifier     6-42

GetOctetString     6-42

OpenSession     6-43

SetInteger     6-43

SetIPAddress     6-44

SetOctetString     6-44

StartWalk     6-45

ExpandURL     2-74

FormatPrice     2-75

FormatTime     2-53

GetManageBandwidth     2-75

GetOriginalURL     2-76

GetPortMapBandwidthKbps     2-76

GetPortMapRoomNumber     2-77

GetPortStateBandwidthKbps     2-78

GetRoomNumber     2-78

GetSearchStatus     2-79

GetSiteNumber     2-80

GetStartPage     2-81

GetSubscriptionEnd     2-66

GetTotalCharge     2-61

GetTotalSeconds     2-62

GetTotalSpent     2-54

GetUserName     2-63

GetWelcomeBack     2-54

IsConnected     2-81

IsExpired     2-66

IsValidCreditCard     2-70

IsValidFolioNumber     2-71

PostSale     2-82

PreConnect     2-83

ResetDenied     2-84

SendActivateSession     2-48, 2-51, 2-58, 2-64, 2-67

SendActivateSession (Daily)     2-55

Subscribe     2-68

WriteDuplicateSessions     2-50

MFC extension DLLs, creating for network element modules     6-5

MinuteICSClear page set     2-33

MinuteICS page set     2-30

modifying

certificate authority settings     D-7

searching page     2-47

N

naming

page sets     2-44

network element modules

creating     6-1, 6-5

testing     6-11

network elements, overview     6-1

NotifyBilling.NotifyBilling object     2-72

BandwidthBoost method     2-72

CheckPage method     2-73

ClientBye method     2-73

ExpandURL method     2-74

FormatPrice method     2-75

GetManageBandwidth method     2-75

GetOriginalURL method     2-76

GetPortMapBandwidthKbps method     2-76

GetPortMapRoomNumber method     2-77

GetPortStateBandwidthKbps method     2-78

GetRoomNumber method     2-78

GetSearchStatus method     2-79

GetSiteNumber method     2-80

GetStartPage method     2-81

IsConnected method     2-81

PostSale method     2-82

PreConnect method     2-83

ResetDenied method     2-84

O

objects

AccessPolicyAccessCodeASP.WebInterface     2-48

AccessPolicyBlockASP.WebInterface     2-51

AccessPolicyDailyASP.WebInterface     2-52

AccessPolicyMinuteASP.WebInterface     2-58

AccessPolicyRADIUSASP.WebInterface     2-59

AccessSubscriptionRADIUSASP.WebInterface     2-65

CruiseLineValidationASP.WebInterface     2-70

NotifyBilling.NotifyBilling     2-72

P

page sets

activating sessions     2-3

controlling access to     2-1

creating     2-1, 2-43

customizing     2-41

naming     2-44

overview     2-1

registering     2-46

renaming     2-42

samples

AccessCode     2-9

BlockICS     2-10

CruiseLine     2-10

DailyHotel     2-15

DailyICS     2-19

DailyICSClear     2-19

MeetingRoom     2-19

Mega     2-21

MinuteICS     2-30

MinuteICSClear     2-33

RADIUS     2-34

RADIUSClear     2-36

RADIUSUBand     2-36

RADIUSUBandClear     2-39

Subscription     2-39

SubscriptionHome     2-39

SubscriptionHotel     2-39

SubscriptionHotelMultipleDay     2-39

SubscriptionICS     2-39

testing     2-47

using BandwidthManager     2-5

using SSL     2-2

using the CommonSubroutines.asp     2-7

using the iport_tools.asp     2-5

PDA page sets, creating     G-1

PMS

policy modules, overview     5-1

posting charges to     F-1

protocols

BellHobic     5-2

Fidelio     5-5

Hilton     5-12

Xiox     5-13

PMS protocols

overview     5-1

procedures

creating access policy modules (DLLs)     3-11

creating accounting policy modules (DLLs)     4-5

creating network element modules (DLLs)     6-5

creating page sets     2-43

creating PMS protocol modules (DLLs)     5-16

customizing page sets     2-42

posting charges remotely to PMS     F-1

projects, building

AccessPolicyBlock     7-2

AccessPolicyBlockASP     7-3

AccessPolicyNull     7-3

PMSProtocolXiox     7-3

TUTDULiteSwitch     7-3

Q

qualifying the network element for BBSM     A-1

R

RADIUSClear page set     2-36

RADIUS page set     2-34

RADIUSUBandClear page set     2-39

RADIUSUBand page set     2-36

read/write file permissions     2-44

reducing searching delay     2-47

reference

access policy API     3-16

accounting policy API     4-10

ActiveX server components and methods     2-48

network element module API     6-13

registering

MFC extension DLLs for PMS protocol modules     5-20

page sets     2-46

release ActiveX server component DLLs     3-16

release MFC extension DLLs     3-15

registry entries for network element modules     6-2

Remote PMS Charge API     F-1

renaming page sets     2-42

retrieving

overwritten page sets     2-43

S

sample DLL implementations     7-1

searching page, modifying     2-47

SendActivateSession method, used in access policies     3-2

session boundary     2-56

sessions, activating in page sets     2-3

SNMP, testing implementation with BBSM     A-1

SSL, using in page sets     2-2

SubscriptionHome page set     2-39

SubscriptionHotelMultipleDay page set     2-39

SubscriptionHotel page set     2-39

SubscriptionICS page set     2-39

Subscription page set     2-39

system messages     2-40, 2-47

T

testing

access policies     3-16

accounting policies     4-9

network element modules (DLLs)     6-11

page sets     2-47

PMS protocol modules (DLLs)     5-20

U

using

BandwidthManager     2-5

CommonSubroutines.asp     2-7

iport_tools.asp     2-5

SSL     2-2

W

wizards

Access Policy AppWizard     3-10

AccessPolicy ASP AppWizard     3-10

Accounting Policy AppWizard     4-4

Cisco BBSM Ethernet Network Element Module AppWizard     6-5

PMS Protocol Module AppWizard     5-15