Chapter 3: Monitor Client Library Functions

In addition to giving you detailed information about Monitor Client Library functions, this chapter contains the following topics:

You use Monitor Client Library functions to write applications that collect Adaptive Server performance data. This chapter describes, in alphabetical order, each Monitor Client Library function. Table 3-1 lists the functions and a brief description of each.

Table 3-1: Monitor Client Library functions

Function

Description

smc_close

Closes a connection

smc_connect_alloc

Creates a connection structure

smc_connect_drop

Deallocates a connection structure

smc_connect_ex

Establishes a connection

smc_connect_props

Sets, retrieves, or clears properties on a connection

smc_create_alarm_ex

Adds an alarm to a data item

smc_create_filter

Adds a filter to a data item

smc_create_playback_session

Initializes a playback session on a Historical Server connection

smc_create_recording_session

Initializes a recording session on a Historical Server connection

smc_create_view

Defines a view

smc_drop_alarm

Removes an alarm from a data item in a view

smc_drop_filter

Removes a filter from a data item in a view

smc_drop_view

Drop a views

smc_get_command_info

Retrieves detailed information about an alarm or error

smc_get_dataitem_type

Retrieves the type of a data item

smc_get_dataitem_value

Retrieves the data for a particular data item and row

smc_get_row_count

Retrieves the number of rows of data in a view

smc_get_version_string

Retrieves the Monitor Client Library version number

smc_initiate_playback

Concludes the definition of views for a playback session

smc_initiate_recording

Concludes the definition of views for a recording session

smc_refresh_ex

Retrieves data for all views in a given connection

smc_terminate_playback

Ends a playback session on a Historical Server connection

smc_terminate_recording

Cancels a recording session on a Historical Server connection

Most functions work with Monitor Server and Historical Server. In this chapter, unless otherwise noted, the term connection means a connection to Monitor Server or Historical Server. See Appendix C, “Backward Compatibility” for information about obsolete functions.