SIP Witch 1.9.15
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions
sipwitch::scripting Class Reference
Inheritance diagram for sipwitch::scripting:
Inheritance graph
[legend]
Collaboration diagram for sipwitch::scripting:
Collaboration graph
[legend]

Public Member Functions

  scripting ()
 
virtual void  period (long slice)
  Period service request. More...
 
virtual bool  announce (MappedRegistry *user, const char *type, const char *event, const char *expires, const char *body)
  Announce a SIP publish event from a registered user to plugins. More...
 
virtual void  registration (voip::reg_t id, regmode_t reg)
  Notify plugins about reply messages from external registrations. More...
 
virtual bool  authenticate (voip::reg_t id, const char *realm)
  Used to verify authentication of a registered session. More...
 
virtual char *  referLocal (MappedRegistry *user, const char *target, char *buffer, size_t size)
  Enables plugin to redirect locally dialed destination to new uri. More...
 
virtual char *  referRemote (MappedRegistry *user, const char *target, char *buffer, size_t size)
  Enables plugin to remap users dialing remote destinations. More...
 
voip::context_t  getContext (const char *uri)
 

Static Public Member Functions

static void  bind (unsigned short port)
 
static void  bind (const char *addr)
 
static void  setPublic (void)
 

Static Public Attributes

static voip::context_t  out_context = NULL
 
static voip::context_t  tcp_context = NULL
 
static voip::context_t  udp_context = NULL
 
static voip::context_t  tls_context = NULL
 

Protected Member Functions

bool  is_active (void) const
 
virtual void  cdrlog (cdr *call)
 
virtual void  errlog (shell::loglevel_t level, const char *text)
 
virtual bool  check (void)
 
virtual void  snapshot (FILE *fp)
 
virtual void  stop (service *cfg)
 
virtual void  publish (service *cfg)
 

Static Protected Member Functions

static void *  alloc (service *cfgp, size_t size)
 
static char *  dup (service *cfgp, const char *s)
 
static bool  is_configured (void)
 

Protected Attributes

unsigned  runlevel
 
bool  active_flag
 

Static Protected Attributes

static LinkedObjectrunlevels [4] = {NULL, NULL, NULL, NULL}
 
static unsigned  count = 0
 
static unsigned short  sip_port = 5060
 
static const char *  sip_iface = NULL
 
static volatile char *  sip_contact = NULL
 
static volatile char *  sip_publish = NULL
 
static int  sip_protocol = IPPROTO_UDP
 
static int  sip_family = AF_INET
 
static int  sip_tlsmode = 0
 
static bool  sip_public = false
 
static const char *  sip_domain = NULL
 
static const char *  sip_realm = "unknown"
 
static const char *  sip_tlspwd = ""
 
static const char *  sip_tlsdev = "/dev/random"
 
static const char *  sip_tlsca = "/etc/ssl/ca.pem"
 
static const char *  sip_tlsdh = "/etc/ssl/dh1024.pem"
 
static const char *  sip_tlskey = "/etc/ssl/private/sipwitch.key"
 
static const char *  sip_tlscert = "/etc/ssl/sipwitch.pem"
 
static unsigned  sip_prefix = 0
 
static unsigned  sip_range = 0
 
static char  session_uuid [40]
 

Private Member Functions

void  start (service *cfg)
 
void  reload (service *cfg)
 
  Notify plugins a user registration is being activated. More...
 
void  expiring (MappedRegistry *rr)
  Notify plugins a user registration has been expired or released. More...
 

Detailed Description

Definition at line 25 of file scripting.cpp.

Constructor & Destructor Documentation

sipwitch::scripting::scripting ( )

Definition at line 39 of file scripting.cpp.

Member Function Documentation

void sipwitch::scripting::activating ( MappedRegistryuser )
privatevirtual

Notify plugins a user registration is being activated.

Parameters
user registration activated.

Reimplemented from sipwitch::modules::sipwitch.

Definition at line 90 of file scripting.cpp.

static void* sipwitch::service::callback::alloc ( servicecfgp,
size_t  size 
)
inlinestaticprotectedinherited

Definition at line 211 of file service.h.

bool sipwitch::modules::sipwitch::announce ( MappedRegistryuser,
const char *  type,
const char *  event,
const char *  expires,
const char *  body 
)
virtualinherited

Announce a SIP publish event from a registered user to plugins.

Parameters
user registration who publushed.
type of message that is published.
event type description, such as "presense" message.
expires time for this message.
body of message published by user agent.
Returns
true if plugin wishes to swallow this message.

Reimplemented in sipwitch::forward.

Definition at line 57 of file modules.cpp.

bool sipwitch::modules::sipwitch::authenticate ( voip::reg_t  id,
const char *  realm 
)
virtualinherited

Used to verify authentication of a registered session.

This is for use by sessions registered by plugins.

Parameters
id of registration (eXosip rid).
realm of this registration.
Returns
true if valid, false if invalid or to ignore in this plugin.

Reimplemented in sipwitch::forward.

Definition at line 66 of file modules.cpp.

static void sipwitch::service::callback::bind ( unsigned short  port )
inlinestaticinherited

Definition at line 238 of file service.h.

void callback::bind ( const char *  addr )
staticinherited

Definition at line 215 of file service.cpp.

void callback::cdrlog ( cdrcall )
protectedvirtualinherited

Definition at line 195 of file service.cpp.

bool callback::check ( void  )
protectedvirtualinherited

Reimplemented in sipwitch::messages, sipwitch::stack, and sipwitch::registry.

Definition at line 186 of file service.cpp.

static char* sipwitch::service::callback::dup ( servicecfgp,
const char *  s 
)
inlinestaticprotectedinherited

Definition at line 214 of file service.h.

void callback::errlog ( shell::loglevel_t  level,
const char *  text 
)
protectedvirtualinherited

Definition at line 191 of file service.cpp.

void sipwitch::scripting::expiring ( MappedRegistryuser )
privatevirtual

Notify plugins a user registration has been expired or released.

Parameters
user registration that was expired.

Reimplemented from sipwitch::modules::sipwitch.

Definition at line 102 of file scripting.cpp.

voip::context_t callback::getContext ( const char *  uri )
inherited

Definition at line 162 of file service.cpp.

bool sipwitch::service::callback::is_active ( void  ) const
inlineprotectedinherited

Definition at line 220 of file service.h.

static bool sipwitch::service::callback::is_configured ( void  )
inlinestaticprotectedinherited

Definition at line 217 of file service.h.

void sipwitch::modules::sipwitch::period ( long  slice )
virtualinherited

Period service request.

A period is an interval during which stats are flushed and refreshed. This notifies the plugin that a period has occured, and what the interval for the period was in seconds.

Parameters
slice of period in seconds.

Definition at line 53 of file modules.cpp.

void callback::publish ( servicecfg )
protectedvirtualinherited

Definition at line 203 of file service.cpp.

char * sipwitch::modules::sipwitch::referLocal ( MappedRegistryuser,
const char *  target,
char *  buffer,
size_t  size 
)
virtualinherited

Enables plugin to redirect locally dialed destination to new uri.

Might be used by a plugin that does per-user speed-dialing database, for example.

Parameters
user that is dialing.
target user dialed.
buffer to store replacement uri in.
size of replacement buffer.
Returns
pointer to buffer or NULL if ignored.

Reimplemented in sipwitch::forward.

Definition at line 71 of file modules.cpp.

char * sipwitch::modules::sipwitch::referRemote ( MappedRegistryuser,
const char *  target,
char *  buffer,
size_t  size 
)
virtualinherited

Enables plugin to remap users dialing remote destinations.

This might be used as a hook for a plugin that maintains gfc peer tables, for example.

Parameters
user that is dialing.
target of remote uri.
buffer to store replacement uri in.
size of replacement buffer.
Returns
pointer to buffer of new uri or NULL ignored.

Definition at line 76 of file modules.cpp.

void sipwitch::modules::sipwitch::registration ( voip::reg_t  id,
regmode_t  reg 
)
virtualinherited

Notify plugins about reply messages from external registrations.

This is used to get result of eXosip SIP registration requests. This might be used to get the result of a plugin registering itself with a gateway or SIP service provider, for example.

Parameters
id of registration (eXosip rid).
result of registration

Reimplemented in sipwitch::forward.

Definition at line 62 of file modules.cpp.

void sipwitch::scripting::reload ( servicecfg )
privatevirtual

Reimplemented from sipwitch::service::callback.

Definition at line 45 of file scripting.cpp.

static void sipwitch::service::callback::setPublic ( void  )
inlinestaticinherited

Definition at line 241 of file service.h.

void callback::snapshot ( FILE *  fp )
protectedvirtualinherited

Reimplemented in sipwitch::messages, sipwitch::stack, and sipwitch::registry.

Definition at line 182 of file service.cpp.

void sipwitch::scripting::start ( servicecfg )
privatevirtual

Reimplemented from sipwitch::service::callback.

Definition at line 67 of file scripting.cpp.

void callback::stop ( servicecfg )
protectedvirtualinherited

Reimplemented in sipwitch::media, sipwitch::stack, and sipwitch::registry.

Definition at line 211 of file service.cpp.

Field Documentation

bool sipwitch::service::callback::active_flag
protectedinherited

Definition at line 184 of file service.h.

unsigned callback::count = 0
staticprotectedinherited

Definition at line 187 of file service.h.

voip::context_t callback::out_context = NULL
staticinherited

Definition at line 233 of file service.h.

unsigned sipwitch::service::callback::runlevel
protectedinherited

Definition at line 183 of file service.h.

LinkedObject * callback::runlevels = {NULL, NULL, NULL, NULL}
staticprotectedinherited

Definition at line 186 of file service.h.

char callback::session_uuid
staticprotectedinherited

Definition at line 206 of file service.h.

volatile char * callback::sip_contact = NULL
staticprotectedinherited

Definition at line 190 of file service.h.

const char * callback::sip_domain = NULL
staticprotectedinherited

Definition at line 196 of file service.h.

int callback::sip_family = AF_INET
staticprotectedinherited

Definition at line 193 of file service.h.

const char * callback::sip_iface = NULL
staticprotectedinherited

Definition at line 189 of file service.h.

unsigned short callback::sip_port = 5060
staticprotectedinherited

Definition at line 188 of file service.h.

unsigned callback::sip_prefix = 0
staticprotectedinherited

Definition at line 204 of file service.h.

int callback::sip_protocol = IPPROTO_UDP
staticprotectedinherited

Definition at line 192 of file service.h.

bool callback::sip_public = false
staticprotectedinherited

Definition at line 195 of file service.h.

volatile char * callback::sip_publish = NULL
staticprotectedinherited

Definition at line 191 of file service.h.

unsigned callback::sip_range = 0
staticprotectedinherited

Definition at line 205 of file service.h.

const char * callback::sip_realm = "unknown"
staticprotectedinherited

Definition at line 197 of file service.h.

const char * callback::sip_tlsca = "/etc/ssl/ca.pem"
staticprotectedinherited

Definition at line 200 of file service.h.

const char * callback::sip_tlscert = "/etc/ssl/sipwitch.pem"
staticprotectedinherited

Definition at line 203 of file service.h.

const char * callback::sip_tlsdev = "/dev/random"
staticprotectedinherited

Definition at line 199 of file service.h.

const char * callback::sip_tlsdh = "/etc/ssl/dh1024.pem"
staticprotectedinherited

Definition at line 201 of file service.h.

const char * callback::sip_tlskey = "/etc/ssl/private/sipwitch.key"
staticprotectedinherited

Definition at line 202 of file service.h.

int callback::sip_tlsmode = 0
staticprotectedinherited

Definition at line 194 of file service.h.

const char * callback::sip_tlspwd = ""
staticprotectedinherited

Definition at line 198 of file service.h.

voip::context_t callback::tcp_context = NULL
staticinherited

Definition at line 234 of file service.h.

voip::context_t callback::tls_context = NULL
staticinherited

Definition at line 236 of file service.h.

voip::context_t callback::udp_context = NULL
staticinherited

Definition at line 235 of file service.h.


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

Generated on Dec 21, 2017 for sipwitch-1.9.15 (*.h and *.cpp), libosip2-5.0.0 (*.h) and libeXosip2-4.0.0 (*.h), by   doxygen 1.8.6

AltStyle によって変換されたページ (->オリジナル) /