Thu Oct 11 06:38:38 2012

Asterisk developer's documentation


ast_security_event_common Struct Reference

Common structure elements. More...

#include <security_events_defs.h>

Collaboration diagram for ast_security_event_common:

Collaboration graph
[legend]

Data Fields

const char * account_id
 Account ID, specific to the service type.
enum ast_security_event_type event_type
 The security event sub-type.
struct ast_security_event_ip_addr local_addr
 Local address the request came in on.
const char * module
 Module, Normally the AST_MODULE define.
struct ast_security_event_ip_addr remote_addr
 Remote address the request came from.
const char * service
 Service that generated the event.
const char * session_id
 Session ID, specific to the service type.
struct timeval * session_tv
 Session timeval, when the session started.
uint32_t version
 security event version

Detailed Description

Common structure elements.

This is the structure header for all event descriptor structures defined below. The contents of this structure are very important and must not change. Even though these structures are exposed via a public API, we have a version field that can be used to ensure ABI safety. If the event descriptors need to be changed or updated in the future, we can safely do so and can detect ABI changes at runtime.

Definition at line 169 of file security_events_defs.h.


Field Documentation

const char* account_id

Account ID, specific to the service type.

Note:
optional/required, depending on event type

Definition at line 190 of file security_events_defs.h.

Local address the request came in on.

Note:
Always required

Definition at line 205 of file security_events_defs.h.

const char* module

Module, Normally the AST_MODULE define.

Note:
Always optional

Definition at line 185 of file security_events_defs.h.

Remote address the request came from.

Note:
Always required

Definition at line 210 of file security_events_defs.h.

const char* service

Service that generated the event.

Note:
Always required
Examples: "SIP", "AMI"

Definition at line 180 of file security_events_defs.h.

Referenced by alloc_event().

const char* session_id

Session ID, specific to the service type.

Note:
Always required

Definition at line 195 of file security_events_defs.h.

struct timeval* session_tv [read]

Session timeval, when the session started.

Note:
Always optional

Definition at line 200 of file security_events_defs.h.

uint32_t version

security event version

Definition at line 173 of file security_events_defs.h.

Referenced by alloc_event(), and ast_security_event_report().


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

Generated on Thu Oct 11 06:38:38 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6