Optional API function macros. More...

This graph shows which files directly or indirectly include this file:

Macros
#define	AST_OPTIONAL_API(result, name, proto, stub) result AST_OPTIONAL_API_NAME(name) proto
	Declare an optional API function. More...

#define	AST_OPTIONAL_API_ATTR(result, attr, name, proto, stub) result __attribute__((attr)) AST_OPTIONAL_API_NAME(name) proto
	Declare an optional API function with compiler attributes. More...

#define	AST_OPTIONAL_API_NAME(name) name
	Expands to the name of the implementation function. More...

#define	AST_OPTIONAL_API_UNAVAILABLE INT_MIN
	A common value for optional API stub functions to return. More...

Detailed Description

Optional API function macros.

Some Asterisk API functions are provided by loadable modules, thus, they may or may not be available at run time depending on whether the providing module has been loaded or not. In addition, there are some modules that are consumers of these APIs that optionally use them; they have only a part of their functionality dependent on the APIs, and can provide the remainder even if the APIs are not available.

An example can be found in agi.h:

AST_OPTIONAL_API(int, ast_agi_register, (struct ast_module *mod, agi_command *cmd),

{ return AST_OPTIONAL_API_UNAVAILABLE; });

This defines the 'ast_agi_register' function as an optional API; if a consumer of this API is loaded when there is no provider of it, then calling this function will actually call the hidden stub, and return the value AST_OPTIONAL_API_UNAVAILABLE. This allows the consumer to safely know that the API is not available, and to avoid using any other APIs from the not-present provider.

In addition to this declaration in the header file, the actual definition of the API function must use the AST_OPTIONAL_API_NAME macro to (possibly) modify the real name of the API function, depending on the specific implementation requirements. The corresponding example from res_agi.c:

int AST_OPTIONAL_API_NAME(ast_agi_register)(struct ast_module *mod, agi_command *cmd)
{
...
}

In the module providing the API, the AST_OPTIONAL_API macro must be informed that it should not build the hidden stub function or apply special aliases to the function prototype; this can be done by defining AST_API_MODULE just before including the header file containing the AST_OPTIONAL_API macro calls.

Definition in file optional_api.h.

Macro Definition Documentation

◆ AST_OPTIONAL_API

#define AST_OPTIONAL_API	(	result,
		name,
		proto,
		stub
	)	result AST_OPTIONAL_API_NAME(name) proto

Declare an optional API function.

Parameters

result	The type of result the function returns
name	The name of the function
proto	The prototype (arguments) of the function
stub	The code block that will be used by the hidden stub when needed

Example usage:

AST_OPTIONAL_API(int, ast_agi_register, (struct ast_module *mod, agi_command *cmd),

{ return AST_OPTIONAL_API_UNAVAILABLE; });

Definition at line 230 of file optional_api.h.

Referenced by __stub__ast_aes_encrypt(), __stub__ast_aes_set_decrypt_key(), __stub__ast_aes_set_encrypt_key(), __stub__ast_agi_register(), __stub__ast_agi_register_multiple(), __stub__ast_agi_unregister(), __stub__ast_beep_start(), __stub__ast_decrypt_bin(), __stub__ast_monitor_change_fname(), __stub__ast_monitor_pause(), __stub__ast_monitor_setjoinfiles(), __stub__ast_monitor_start(), __stub__ast_monitor_stop(), __stub__ast_websocket_client_create(), __stub__ast_websocket_read(), and __stub__ast_websocket_write().

◆ AST_OPTIONAL_API_ATTR

#define AST_OPTIONAL_API_ATTR	(	result,
		attr,
		name,
		proto,
		stub
	)	result __attribute__((attr)) AST_OPTIONAL_API_NAME(name) proto

Declare an optional API function with compiler attributes.

Parameters

result	The type of result the function returns
attr	Any compiler attributes to be applied to the function (without the attribute wrapper)
name	The name of the function
proto	The prototype (arguments) of the function
stub	The code block that will be used by the hidden stub when needed

Definition at line 233 of file optional_api.h.

Referenced by __stub__ast_agi_unregister_multiple().

◆ AST_OPTIONAL_API_NAME

#define AST_OPTIONAL_API_NAME ( name ) name

Expands to the name of the implementation function.

Definition at line 228 of file optional_api.h.

Referenced by ast_websocket_client_create(), ast_websocket_read_string(), websocket_client_connect(), and websocket_client_create().

◆ AST_OPTIONAL_API_UNAVAILABLE

#define AST_OPTIONAL_API_UNAVAILABLE INT_MIN

A common value for optional API stub functions to return.

This value is defined as INT_MIN, the minimum value for an integer (maximum negative value), which can be used by any optional API functions that return a signed integer value and would not be able to return such a value under normal circumstances.

Definition at line 74 of file optional_api.h.

Referenced by __stub__ast_agi_register(), __stub__ast_agi_register_multiple(), __stub__ast_agi_send(), __stub__ast_agi_unregister(), __stub__ast_agi_unregister_multiple(), and AST_TEST_DEFINE().