Public Member Functions | Protected Member Functions

AmSessionFactory Class Reference

Interface for plugins to create sessions. More...

#include <AmApi.h>

Inheritance diagram for AmSessionFactory:
AmPluginFactory AnnounceAuthFactory AnnounceB2BFactory AnnouncementFactory AnnounceTransferFactory AnnRecorderFactory AnswerMachineFactory b2b_connectFactory CacheAnnounceFactory CallBackFactory CallGenFactory Click2DialFactory ConferenceFactory DSMFactory DtmfTesterFactory EarlyAnnounceFactory EarlyRecordFactory EchoFactory GatewayFactory IvrFactory JukecallFactory MyAnnounceAppFactory MyAppFactory MyAppFactory MyCCFactory MyConfigurableAppFactory MyJukeboxFactory PinAuthConferenceFactory PrecodedFactory PySemsFactory RegistrationAgentFactory RtmpFactory SBCFactory ServiceLineFactory SimpleConferenceFactory UrlCatcherFactory VoiceboxFactory WebConferenceFactory

Public Member Functions

void configureSession (AmSession *sess)
 AmSessionFactory (const string &name)
virtual AmSession * onInvite (const AmSipRequest &req, const string &app_name, const map< string, string > &app_params)=0
virtual AmSession * onInvite (const AmSipRequest &req, const string &app_name, AmArg &session_params)
virtual AmSession * onRefer (const AmSipRequest &req, const string &app_name, const map< string, string > &app_params)
virtual AmSession * onRefer (const AmSipRequest &req, const string &app_name, AmArg &session_params)
virtual void onOoDRequest (const AmSipRequest &req)

Protected Member Functions

int configureModule (AmConfigReader &cfg)

Detailed Description

Interface for plugins to create sessions.

Member Function Documentation

int AmSessionFactory::configureModule ( AmConfigReader &  cfg  )  [protected]

This reads the module configuration from cfg into the modules mod_conf.

Referenced by VoiceboxFactory::onLoad(), ServiceLineFactory::onLoad(), RegistrationAgentFactory::onLoad(), PySemsFactory::onLoad(), PinAuthConferenceFactory::onLoad(), IvrFactory::onLoad(), GatewayFactory::onLoad(), EarlyAnnounceFactory::onLoad(), DtmfTesterFactory::onLoad(), ConferenceFactory::onLoad(), Click2DialFactory::onLoad(), CacheAnnounceFactory::onLoad(), AnswerMachineFactory::onLoad(), AnnRecorderFactory::onLoad(), AnnounceTransferFactory::onLoad(), AnnouncementFactory::onLoad(), AnnounceB2BFactory::onLoad(), and AnnounceAuthFactory::onLoad().

void AmSessionFactory::configureSession ( AmSession *  sess  ) 

This function applys the module configuration

AmSession * AmSessionFactory::onInvite ( const AmSipRequest &  req,
const string &  app_name,
AmArg &  session_params 
) [virtual]

Creates a dialog state on new UAC request.

Parameters:
session_params parameters passed to the new session by the caller.
Returns:
0 if the request is not acceptable.

Warning: This method should not make any expensive processing as it would block the server.

Reimplemented in AnnouncementFactory, AnnRecorderFactory, Click2DialFactory, DtmfTesterFactory, EarlyRecordFactory, PinAuthConferenceFactory, and SimpleConferenceFactory.

References onInvite().

virtual AmSession* AmSessionFactory::onInvite ( const AmSipRequest &  req,
const string &  app_name,
const map< string, string > &  app_params 
) [pure virtual]

Creates a dialog state on new UAS request.

Returns:
0 if the request is not acceptable.

Warning: This method should not make any expensive processing as it would block the server.

Implemented in EchoFactory, AnnounceB2BFactory, AnnounceTransferFactory, AnnouncementFactory, AnnRecorderFactory, Click2DialFactory, ConferenceFactory, EarlyAnnounceFactory, AnnounceAuthFactory, b2b_connectFactory, CacheAnnounceFactory, DtmfTesterFactory, EarlyRecordFactory, JukecallFactory, MyAppFactory, PinAuthConferenceFactory, ServiceLineFactory, SimpleConferenceFactory, MyAnnounceAppFactory, MyAppFactory, MyCCFactory, MyConfigurableAppFactory, MyJukeboxFactory, UrlCatcherFactory, IvrFactory, PrecodedFactory, RegistrationAgentFactory, VoiceboxFactory, and AnswerMachineFactory.

Referenced by AmSessionContainer::createSession(), and onInvite().

void AmSessionFactory::onOoDRequest ( const AmSipRequest &  req  )  [virtual]

Method to receive any out-of-dialog request other than INVITE and REFER

Warning: This method should not make any expensive processing as it would block the thread posting the event!

References AmSession::getSessionNum(), AmConfig::OptionsTranscoderInStatsHdr, AmConfig::OptionsTranscoderOutStatsHdr, and AmSipDialog::reply_error().

AmSession * AmSessionFactory::onRefer ( const AmSipRequest &  req,
const string &  app_name,
const map< string, string > &  app_params 
) [virtual]

Creates a dialog state on new REFER with local-tag.

Returns:
0 if the request is not acceptable.

Warning: This method should not make any expensive processing as it would block the server.

Reimplemented in ConferenceFactory.

Referenced by AmSessionContainer::createSession(), and onRefer().

AmSession * AmSessionFactory::onRefer ( const AmSipRequest &  req,
const string &  app_name,
AmArg &  session_params 
) [virtual]

Creates a dialog state on new REFER with local-tag. Passes session_params to the new session.

Returns:
0 if the request is not acceptable.

Warning: This method should not make any expensive processing as it would block the server.

References onRefer().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.7.1
Home |  Recent changes |  Search |  Glossary |  Sitemap |  Login