English dropdown-ico

Intel OA&M API for Linux Operating manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Go to page of

Similar user manuals

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of Intel OA&M API for Linux Operating, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Intel OA&M API for Linux Operating one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of Intel OA&M API for Linux Operating. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of Intel OA&M API for Linux Operating should contain:
- informations concerning technical data of Intel OA&M API for Linux Operating
- name of the manufacturer and a year of construction of the Intel OA&M API for Linux Operating item
- rules of operation, control and maintenance of the Intel OA&M API for Linux Operating item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Intel OA&M API for Linux Operating alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Intel OA&M API for Linux Operating, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Intel service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Intel OA&M API for Linux Operating.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the Intel OA&M API for Linux Operating item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

    O A&M API f or Lin ux Operating Systems Pr ogramming Guide A ugust 2005 05-1850-00 4[...]

  • Page 2

    OA&M API for Linux Programming Guide – August 2005 INFORMA TION IN THIS DO CUMENT IS PRO VIDED IN CONNECTION WITH INTEL® PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED , BY EST OPPEL OR OTHER WISE, TO ANY INTELLECTU AL PROPER TY RIGHTS IS GRANTED BY THIS DOCUMENT . EXCEPT AS PRO VIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS,[...]

  • Page 3

    OA&M API for Linu x Programming Guide – August 2005 3 Contents Revision H istory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 [...]

  • Page 4

    4 OA&M API for Linux Programming Guide – August 2005 Contents Figures 1 OA&M API Clas ses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 2 Event Notifi cation Framew ork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

  • Page 5

    OA&M API for Linu x Programming Guide — August 2005 5 Re vision Histor y This re vision history summarizes the changes made in each published vers ion of this document. Document No. Publication Date Description of Revisions 05-1850-004 A u gust 2005 General Guidelines section : Added information a bout freeing memor y that is allocated for ob[...]

  • Page 6

    6 OA&M API for Linux Progra mming Guide — August 2005 Revisi on History[...]

  • Page 7

    OA&M API for Linu x Programming Guide — August 2005 7 About This Pub lication The following topics provide information about this publicati on: • Purpose • Intended Audience • How to Use This Publication • Related Information Purpose This publication provides guid elines for building applications using the Operatio ns, Administration [...]

  • Page 8

    8 OA&M API for Linux Progra mming Guide — August 2005 About This Public ation The information in this guide is or ganized as follo ws: • Chapter 1, “Produ ct Description” provides an o vervie w of the O A&M A PI. • Chapter 2, “Event Handling” describes how to register with the O A&M event notification frame work and handle[...]

  • Page 9

    OA&M API for Linu x Programming Guide — August 2005 9 1 1 . Pr oduct Description This chapter describes the O A &M API. The following topi cs are included: • O A&M API Overvie w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 • Features . . . . . . . . . . . . . . . . . . . . .[...]

  • Page 10

    10 OA&M API for Linux Progra mming Guide — August 2005 Produc t Description Figure 1. O A&M API Classes 1.2 Features The features av ai lable through the OA&M API include the following: • Get version information (major release number , release build number , service pack number, feature pack number , service update number , feature [...]

  • Page 11

    OA&M API for Linu x Programming Guide — August 2005 11 Pr oduct Descriptio n for Linux Operating Systems Library Refer ence for informatio n about the CTPLA TFORMVERSIONINFO data structure and the ICTNode::GetSystemRe leaseVersionInfo( ) function. • Get physical identification information (serial number, PCI slot number , number of network [...]

  • Page 12

    12 OA&M API for Linux Progra mming Guide — August 2005 Produc t Description Figure 2. Event Notification Frame work Intel ® Dialogic system software components, such as de vice driv ers and firmware, are the supplier objects. They generate e vents that are broadcas t to consumer objects via the e vent notif ication channels. The DlgAdminCons[...]

  • Page 13

    OA&M API for Linu x Programming Guide — August 2005 13 Pr oduct Descriptio n The framew ork cont ains the following e vent notif ication channels, each of which carries specific types of e vents: • ADMIN_CHANNEL • CLOCK_EVENT_CHANNEL • F A UL T_CHANNEL • NETWORK_ALARM_CHANNEL Notes: 1. DM3 architecture boards generate e vents on al l [...]

  • Page 14

    14 OA&M API for Linux Progra mming Guide — August 2005 Produc t Description[...]

  • Page 15

    OA&M API for Linu x Programming Guide — August 2005 15 2 2 . Event Handling This chapter provides informat ion about receiving and handling asynchronous ev ents that are transmitted via the event notif i cation framew o rk. For your application to receive e vents from the ev ent no tification frame work you must follow these steps: 1. Define [...]

  • Page 16

    16 OA&M API for Linux Progra mming Guide — August 2005 Event Handling[...]

  • Page 17

    OA&M API for Linu x Programming Guide — August 2005 17 3 3 . Err or Handling This chapter describes the error handling capabilities provided b y the O A&M API. When an error occurs during ex ecution of a function in one of the System Component classes (CCTDomain, ICTN ode, ICTBoard or ICTCl ockAgent) , an exception is thro wn. Exceptions [...]

  • Page 18

    18 OA&M API for Linux Progra mming Guide — August 2005 Error Handling[...]

  • Page 19

    OA&M API for Linu x Programming Guide — August 2005 19 4 4 . Application De velopment Guidelines This chapter provides informatio n about developing applications using the O A&M API. It includes the following sections: • General Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

  • Page 20

    20 OA&M API for Linux Progra mming Guide — August 2005 Application Development Gu idelines • ICTClockAgent::SetTDMBusConfiguration( ) 4.2 Designing CT Bus Cloc king Applications If you are using an y of ICTC lockAgent class me mber functions (for example, to dev elop a customized system clo cking daemon) you must disa ble the clocking daemo[...]

  • Page 21

    OA&M API for Linu x Programming Guide — August 2005 21 Application Development Guide lines 6. When the stopbrd utility successfully stops the board, use the removebrd ut ility to notify the system that the board is being removed. 7. Physically remo ve the board from the chass i s when the board’ s Out of Service (Blue) LED lights. 8. Insert[...]

  • Page 22

    22 OA&M API for Linux Progra mming Guide — August 2005 Application Development Gu idelines[...]

  • Page 23

    OA&M API for Linu x Programming Guide — August 2005 23 5 5 . Building Applications This chapter provides general information for building applications that use the O A&M librar y . The follo wing topics are in cluded in this chapter: • Compiling and Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

  • Page 24

    24 OA&M API for Linux Progra mming Guide — August 2005 Building Applications dlgeventproxydef.h defines the generic data structure for O A&M ev ents Note: User-def ined header files that pro v ide an implemen tation of the CEventHandlerAdaptor class (i.e., adminhandler.h) and override its CEventHandlerAdap tor::HandleEvent ( ) function al[...]

  • Page 25

    OA&M API for Linu x Programming Guide — August 2005 25 Inde x A array of filters 15 C CCTDasiException 9 , 17 CEventHandlerAdaptor 12 , 15 class heirarchy 11 , 19 client data 15 CT Bus 8 D dasi.h 23 devices virtual 20 DlgAdminConsumer 12 dlgadminconsumer.h 23 dlgadminevents.h 23 dlgadminmsg.h 23 dlgcclockinge vents.h 23 dlgcnetworkalarmevents[...]

  • Page 26

    26 OA&M API for Linux Progra mming Guide — August 2005[...]