About this Guide

---

Published: May 27, 2013

Introduction

This document describes the Cisco Service Control Subscriber Manager C/C++ API.

You use the Cisco Service Control Subscriber Manager C/C++ API to update, query, and configure the Cisco Service Control Subscriber Manager. This API has two parts, which you can use separately or together without restriction:

•Cisco Service Control Subscriber Manager Nonblocking C/C++ API—A high-performance API with low visibility to errors and to operation results. This part of the API supports automatic integrations with OSS/AAA systems.

•Cisco Service Control Subscriber Manager Blocking C/C++ API— This part of the API supports user-interface applications, which access and manage the Cisco Service Control Subscriber Manager.

---

Note A set of APIs with the same functionality is also available for the Java environment.

---

This document is for networking or computer technicians responsible for configuring the Cisco Service Control Subscriber Manager. It is also intended for the operator who manages Cisco Service Control Engine (Cisco SCE) platforms.

Document Revision History

The following Document Revision History table records the changes made to this document.

Table 1 Document Revision History 

Revision	Cisco Service Control Release and Date	Change Summary
OL-29116-01	Release 4.0.x May 27, 2013	First version of this document (new for the Release 4.0.x train).

Organization

This guide contains the following sections.

Table 2 Document Organization 

Section	Title	Description
Chapter 1	Getting Started	Describes the platforms on which the C/C++ API can be used, and how to install, compile, and start running the C/C++ API component.
Chapter 2	General API Concepts	Describes the various concepts that are used when working with the SM C/C++ API.
Chapter 3	Blocking API	Describes the features and operation of the blocking API and provides code examples.
Chapter 4	Nonblocking API	Describes the features and operation of the nonblocking API and provides code examples.
Appendix A	List of Error Codes	Lists the error codes that are used in the C/C++ API.

Related Documentation

Use this document in conjunction with all the Cisco Service Control Subscriber Manager user, API, and reference guides.

Conventions

This document uses the following conventions.

Table 3 Conventions 

Convention	Indication
bold font	Commands and keywords and user-entered text appear in bold font.
italic font	Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.
[ ]	Elements in square brackets are optional.
{x | y | z }	Required alternative keywords are grouped in braces and separated by vertical bars.
[ x | y | z ]	Optional alternative keywords are grouped in brackets and separated by vertical bars.
string	Nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
courier font	Terminal sessions and information the system displays appear in courier font.
< >	Nonprinting characters such as passwords are in angle brackets.
[ ]	Default responses to system prompts are in square brackets.
!, #	An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.

---

Note Means reader take note.

---

---

Tip Means the following information will help you solve a problem.

---

---

Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

---

---

Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.

---

Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.