Prosody generic: API: sm_shutdown_module

Prototype Definition

int sm_shutdown_module(struct sm_shutdown_module_parms *shutdownp)

Parameters

*shutdownp

a structure of the following type:

typedef struct sm_shutdown_module_parms {
	tSMModuleId module_id;					/* in */
} SM_SHUTDOWN_MODULE_PARMS;

Description

Initiates the closing of a Prosody module that was opened with sm_open_module(). Card types that use asynchronous control methods may block in sm_close_module(). This function initiates the close procedure and does not block. The resources used are not released until sm_close_module() is called, which may still block unless sm_module_status() has reported a status of kSMModuleStatusShutdown. It is a serious error to close a module on which there are open channels.

Fields

module_id

The value obtained from sm_open_module() to be closed.

Returns

0 if call completed successfully, otherwise a standard error.

This function is part of the Prosody generic API.