ast_parking_bridge_feature_fn_table Struct Reference

A function table providing parking functionality to the Bridging API Bridging API and other consumers. More...

#include <parking.h>

Collaboration diagram for ast_parking_bridge_feature_fn_table:

Collaboration graph
[legend]

Data Fields

struct ast_module_infomodule_info
 The module info for the module registering this parking provider.
const char * module_name
 The name of the module that provides this parking functionality.
unsigned int module_version
 The version of this function table. If the ABI for this table changes, the module version (/ref PARKING_MODULE_VERSION) should be incremented.
int(* parking_blind_transfer_park )(struct ast_bridge_channel *parker, const char *context, const char *exten, transfer_channel_cb parked_channel_cb, struct transfer_channel_data *parked_channel_data)
 Perform a blind transfer to a parking extension.
int(* parking_is_exten_park )(const char *context, const char *exten)
 Determine if the context/exten is a "parking" extension.
int(* parking_park_bridge_channel )(struct ast_bridge_channel *parkee, const char *parkee_uuid, const char *parker_uuid, const char *app_data)
 Perform a direct park on a channel in a bridge.
int(* parking_park_call )(struct ast_bridge_channel *parker, char *exten, size_t length)
 Park the bridge and/or callers that this channel is in.

Detailed Description

A function table providing parking functionality to the Bridging API Bridging API and other consumers.

Definition at line 124 of file parking.h.


Field Documentation

struct ast_module_info* module_info [read]

The module info for the module registering this parking provider.

Definition at line 199 of file parking.h.

Referenced by load_parking_bridge_features().

const char* module_name

The name of the module that provides this parking functionality.

Definition at line 136 of file parking.h.

Referenced by unload_parking_bridge_features().

unsigned int module_version

The version of this function table. If the ABI for this table changes, the module version (/ref PARKING_MODULE_VERSION) should be incremented.

Definition at line 131 of file parking.h.

Referenced by ast_parking_register_bridge_features().

int(* parking_blind_transfer_park)(struct ast_bridge_channel *parker, const char *context, const char *exten, transfer_channel_cb parked_channel_cb, struct transfer_channel_data *parked_channel_data)

Perform a blind transfer to a parking extension.

Parameters:
parker The bridge_channel object that is initiating the parking
context The context to blind transfer to
exten The extension to blind transfer to
parked_channel_cb Execute the following function on the the channel that gets parked
parked_channel_data Data for the parked_channel_cb
Note:
If the bridge parker is in has more than one other occupant, the entire bridge will be parked using a Local channel

This is safe to be called outside of the Bridging API Bridging API.

Return values:
0 on success
non-zero on error

int(* parking_is_exten_park)(const char *context, const char *exten)

Determine if the context/exten is a "parking" extension.

Return values:
0 if the extension is not a parking extension
1 if the extension is a parking extension

int(* parking_park_bridge_channel)(struct ast_bridge_channel *parkee, const char *parkee_uuid, const char *parker_uuid, const char *app_data)

Perform a direct park on a channel in a bridge.

Parameters:
parkee The channel in the bridge to be parked.
parkee_uuid The UUID of the channel being packed.
parker_uuid The UUID of the channel performing the park.
app_data Data to pass to the Park application
Note:
This must be called within the context of the Bridging API Bridging API. External entities should not call this method directly, but should instead use the direct call parking method or the blind transfer method.
Return values:
0 on success
non-zero on error

int(* parking_park_call)(struct ast_bridge_channel *parker, char *exten, size_t length)

Park the bridge and/or callers that this channel is in.

Parameters:
parker The bridge_channel parking the bridge
exten Optional. The extension the channel or bridge was parked at if the call succeeds.
length Optional. If exten is specified, the size of the buffer.
Note:
This is safe to be called outside of the Bridging API Bridging API.
Return values:
0 on success
non-zero on error


The documentation for this struct was generated from the following file:

Generated on Thu Apr 16 06:35:27 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6