Home |  Recent changes |  Search |  Glossary |  Sitemap |  Login

About |  News |  SIP Resources |  Documentation |  Downloads |  Projects |  SIP Service |  Support          Project shortcuts:  SER |  SERweb |  SEMS

AmApi.h

Go to the documentation of this file.

/*
 * $Id: AmApi.h 923 2008-04-30 15:02:22Z sayer $
 *
 * Copyright (C) 2002-2003 Fhg Fokus
 * Copyright (C) 2006 iptego GmbH
 *
 * This file is part of sems, a free SIP media server.
 *
 * sems is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * For a license to use the ser software under conditions
 * other than those described here, or to purchase support for this
 * software, please contact iptel.org by e-mail at the following addresses:
 *    info@iptel.org
 *
 * sems is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef _AmApi_h_
#define _AmApi_h_

#include "AmThread.h"
#include "AmSipMsg.h"
#include "AmConfig.h"
#include "AmArg.h"
#include "AmEventQueue.h"

#include <stdarg.h>

#include <string>
using std::string;

class AmDynInvoke
{
 public:
  struct NotImplemented {
    string what;
    NotImplemented(const string& w)
      : what(w) {}
  };

  AmDynInvoke();
  virtual ~AmDynInvoke();
  virtual void invoke(const string& method, const AmArg& args, AmArg& ret);
};

class AmPluginFactory
{
  string plugin_name;

 public:
  AmPluginFactory(const string& name)
    : plugin_name(name) {}

  virtual ~AmPluginFactory() {}

  const string& getName() { return plugin_name; } 

  virtual int onLoad()=0;
};

class AmDynInvokeFactory: public AmPluginFactory
{
 public:
  AmDynInvokeFactory(const string& name);
  virtual AmDynInvoke* getInstance()=0;
};


class AmSession;
class AmSessionEventHandler;
class AmSessionEventHandlerFactory: public AmPluginFactory
{
 public:
  AmSessionEventHandlerFactory(const string& name);

  virtual AmSessionEventHandler* getHandler(AmSession*)=0;

  virtual bool onInvite(const AmSipRequest& req)=0;
  virtual bool onInvite(const AmSipRequest& req, AmArg& session_params);
};

class AmSessionFactory: public AmPluginFactory
{

  AmSessionTimerConfig mod_conf;

 protected:
  int configureModule(AmConfigReader& cfg);

 public:
  void configureSession(AmSession* sess);

  AmSessionFactory(const string& name);

  virtual AmSession* onInvite(const AmSipRequest& req)=0;

  virtual AmSession* onInvite(const AmSipRequest& req, 
                              AmArg& session_params);

  virtual AmSession* onRefer(const AmSipRequest& req);

  virtual AmSession* onRefer(const AmSipRequest& req, 
                             AmArg& session_params);

  virtual void postEvent(AmEvent* ev);  

};

class AmSIPEventHandler : public AmPluginFactory 
{

 public:
  AmSIPEventHandler(const string& name);
  virtual ~AmSIPEventHandler() { }

  virtual bool onSipReply(const AmSipReply& rep) = 0;
};

class AmLoggingFacility : public AmPluginFactory
{

 public:
  AmLoggingFacility(const string& name);
  virtual ~AmLoggingFacility() { }

  virtual void log(int level, const char* msg) = 0;
};

class AmInterfaceHandler;

class AmCtrlInterface: public AmThread
{
 public:
  AmCtrlInterface();
  virtual ~AmCtrlInterface();
  
  //@param serKey    [out] An out parameter
  //@param serKeyLen [out] An out parameter
  
  virtual int send(const AmSipRequest &, 
                   char* serKey, unsigned int& serKeyLen) = 0;
  
  virtual int send(const AmSipReply &) = 0;
  
  virtual string getContact(const string &displayName, 
                            const string &userName, const string &hostName, 
                            const string &uriParams, const string &hdrParams) = 0;
};

class AmCtrlInterfaceFactory : public AmPluginFactory
{
  public:
    AmCtrlInterfaceFactory(const string& name);
    virtual ~AmCtrlInterfaceFactory() {}

    virtual AmCtrlInterface* instance() = 0;
};

#if  __GNUC__ < 3
#define EXPORT_FACTORY(fctname,class_name,args...) \
            extern "C" void* fctname()\
            {\
                return new class_name(##args);\
            }
#else
#define EXPORT_FACTORY(fctname,class_name,...) \
            extern "C" void* fctname()\
            {\
                return new class_name(__VA_ARGS__);\
            }
#endif

typedef void* (*FactoryCreate)();

#define STR(x) #x
#define XSTR(x) STR(x)

#define FACTORY_SESSION_EXPORT      session_factory_create
#define FACTORY_SESSION_EXPORT_STR  XSTR(FACTORY_SESSION_EXPORT)

#define EXPORT_SESSION_FACTORY(class_name,app_name) \
            EXPORT_FACTORY(FACTORY_SESSION_EXPORT,class_name,app_name)

#define FACTORY_SESSION_EVENT_HANDLER_EXPORT     sess_evh_factory_create
#define FACTORY_SESSION_EVENT_HANDLER_EXPORT_STR XSTR(FACTORY_SESSION_EVENT_HANDLER_EXPORT)

#define EXPORT_SESSION_EVENT_HANDLER_FACTORY(class_name,app_name) \
            EXPORT_FACTORY(FACTORY_SESSION_EVENT_HANDLER_EXPORT,class_name,app_name)

#define FACTORY_PLUGIN_EXPORT     base_plugin_create
#define FACTORY_PLUGIN_EXPORT_STR XSTR(FACTORY_PLUGIN_EXPORT)

#define EXPORT_PLUGIN_FACTORY(class_name,app_name) \
            EXPORT_FACTORY(FACTORY_PLUGIN_EXPORT,class_name,app_name)

#define FACTORY_PLUGIN_CLASS_EXPORT     plugin_class_create
#define FACTORY_PLUGIN_CLASS_EXPORT_STR XSTR(FACTORY_PLUGIN_CLASS_EXPORT)

#define EXPORT_PLUGIN_CLASS_FACTORY(class_name,app_name) \
            EXPORT_FACTORY(FACTORY_PLUGIN_CLASS_EXPORT,class_name,app_name)

#define FACTORY_SIP_EVENT_HANDLER_EXPORT     sip_evh_factory_create
#define FACTORY_SIP_EVENT_HANDLER_EXPORT_STR XSTR(FACTORY_SIP_EVENT_HANDLER_EXPORT)

#define EXPORT_SIP_EVENT_HANDLER_FACTORY(class_name,app_name) \
            EXPORT_FACTORY(FACTORY_SIP_EVENT_HANDLER_EXPORT,class_name,app_name)

#define FACTORY_LOG_FACILITY_EXPORT     log_facilty_factory_create
#define FACTORY_LOG_FACILITY_EXPORT_STR XSTR(FACTORY_LOG_FACILITY_EXPORT)

#define EXPORT_LOG_FACILITY_FACTORY(class_name,app_name) \
            EXPORT_FACTORY(FACTORY_LOG_FACILITY_EXPORT,class_name,app_name)

/* 
 * defines for exporting a control interface plugin 
 */
#define FACTORY_CONTROL_INTERFACE_EXPORT  control_interface_factory_create
#define FACTORY_CONTROL_INTERFACE_EXPORT_STR  \
    XSTR(FACTORY_CONTROL_INTERFACE_EXPORT)
#define EXPORT_CONTROL_INTERFACE_FACTORY(class_name, app_name)  \
    EXPORT_FACTORY(FACTORY_CONTROL_INTERFACE_EXPORT, class_name, app_name)
#endif

---

Legal Notices |  Privacy Policy

Home |  Recent changes |  Search |  Glossary |  Sitemap |  Login

Copyright (c) 2001-2007 iptel.org. All rights reserved.

Sponsored by FhG FOKUS, iptelorg GmbH, and iptego GmbH