Thu Oct 11 06:50:29 2012

Asterisk developer's documentation


ast_tone_zone Struct Reference

A set of tones for a given locale. More...

#include <indications.h>


Public Member Functions

 AST_LIST_HEAD_NOLOCK (, ast_tone_zone_sound) tones
 A list of tones for this locale.

Data Fields

union {
   struct {
      unsigned int   killme:1
   } 
   uint32_t   __padding
}; 
 Flags only used internally.
char country [5]
 Country code that this set of tones is for.
char description [40]
 Text description of the given country.
unsigned int nrringcadence
 Number of ring cadence elements in the ringcadence array.
int * ringcadence
 Array of ring cadence parts.


Detailed Description

A set of tones for a given locale.

Note:
If a reference to this tone zone is held, then the country is guaranteed not to change. It is safe to read it without locking the tone zone. This is not the case for any other field.

Definition at line 71 of file indications.h.


Member Function Documentation

AST_LIST_HEAD_NOLOCK ( ast_tone_zone_sound   ) 

A list of tones for this locale.


Field Documentation

union { ... }

Flags only used internally.

uint32_t __padding

Definition at line 93 of file indications.h.

char country[5]

char description[40]

Text description of the given country.

This is for nothing more than friendly display to a human.

Definition at line 79 of file indications.h.

Referenced by ast_var_indications_table(), handle_cli_indication_show(), is_valid_tone_zone(), and store_config_tone_zone().

unsigned int killme

Definition at line 95 of file indications.h.

Referenced by prune_tone_zone(), reset_tone_zone(), and tone_zone_mark().

unsigned int nrringcadence

Number of ring cadence elements in the ringcadence array.

Definition at line 81 of file indications.h.

Referenced by ast_get_indication_zone(), ast_unregister_indication_country(), handle_cli_indication_show(), parse_tone_zone(), reset_tone_zone(), and store_tone_zone_ring_cadence().

Array of ring cadence parts.

Each element is an amount of time in milliseconds. The first element is for time on, and from there it alternates between on and off.

Definition at line 88 of file indications.h.

Referenced by ast_tone_zone_destructor(), handle_cli_indication_show(), reset_tone_zone(), and store_tone_zone_ring_cadence().


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

Generated on Thu Oct 11 06:50:29 2012 for Asterisk - the Open Source PBX by  doxygen 1.5.6