Service manager function summary

This topic presents a summary of the service manager functions:

Life cycle binding functions
Runtime binding functions

Life cycle binding functions

Registration

The following binding functions are used to register Natural Access services and service managers. Both of these functions are synchronous:

Function	Description
xxxInitializeManager	Acts as an entry point into service. Declares binding functions and version numbers and compatibility levels for service manager.
xxxDefineService	Declares version numbers, compatibility levels, and parameters for service.

Event handling

The following binding functions are used to initialize and shut down event handling. Both of these functions are synchronous:

Function	Description
xxxAttachServiceManager	Initializes communication with managed resource. Can declare wait objects and allocate queuecontext data structure.
xxxDetachServiceManager	De-allocates data structures allocated with xxxAttachServiceManager.

Service startup/shutdown

The following binding functions are used during service startup and shutdown:

Function	Synchronous/ asynchronous	Description
xxxOpenServiceManager	Synchronous	Allocates managed resource data structure that pertains to the specific context.
xxxOpenService	Asynchronous	Initializes the managed resource.
xxxCloseServiceManager	Synchronous	De-allocates any data structures opened with xxxOpenServiceManager.
xxxCloseService	Asynchronous	Shuts down the managed resource.

Runtime control

The following binding functions are invoked when a service associates a runtime control action with a service specific event. Both of these functions are synchronous:

Function	Description
xxxAddRTC	Service-specific actions taken when dispAddRTC function is called.
xxxRemoveRTC	Service-specific actions taken when dispRemoveRTC function is called.

Runtime binding functions

Command processing

The xxxProcessCommand binding function enables you to process service commands. This function is synchronous.

Trace handling

The following binding functions enable you to control tracing for specific services. Both of these functions are synchronous:

Function	Description
xxxFormatTraceBuffer	Formats a service-specific trace buffer.
xxxSetTraceLevel	Sets the tracemask for a specific service on a per context basis.

Error handling

The following binding functions are used to convert binary codes and trace records to ASCII. Both of these functions are synchronous:

Function	Description
xxxFormatMessage	Formats a command or event that was generated by the service.
xxxGetText	Retrieves the service-specific textual representation of an error, reason, event, or command code.

Event processing

The xxxProcessEvent binding function is used to process events from other services. This function is synchronous.