libexec.h

Go to the documentation of this file.

// Copyright (C) 2005 Open Source Telecom Corp.
//  
// This program 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.
// 
// This program 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.
// 
// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// ccScript.  If you copy code from other releases into a copy of GNU
// ccScript, as the General Public License permits, the exception does
// not apply to the code that you add in this way.  To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU ccScript, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//

#ifndef CCXX_LIBEXEC_H_
#define CCXX_LIBEXEC_H_

#ifndef CCXX_BAYONNE_H_
#include <cc++/bayonne.h>
#endif

#ifndef CCXX_SLOG_H_
#include <cc++/slog.h>
#endif

#ifndef CCXX_PROCESS_H_
#include <cc++/process.h>
#endif

namespace ost {

class __EXPORT Libexec : public Bayonne
{
protected:
        Keydata head, args;
        const char *tsid;
        const char *voice;
        Audio::Level level;

public:
        result_t result;
        char digits[64];
        char query[512];
        char position[32];
        unsigned exitcode, reply;

        Libexec();

        const char *getEnv(const char *id);

        const char *getArg(const char *id);     

        const char *getPath(const char *filename, char *buffer, unsigned size);

        const char *getFile(const char *filename);

        inline void setVoice(const char *voice)
                {voice = voice;};

        inline void setLevel(Audio::Level level)
                {level = level;};

        void hangupSession(void);

        void detachSession(unsigned code);

        result_t sendCommand(const char *text, char *buffer = NULL, unsigned size = 0);

        result_t sendResult(const char *text);

        void sendError(const char *msg);

        result_t xferCall(const char *dest);

        result_t replayFile(const char *file);

        result_t replayOffset(const char *file, const char *offset);                                                                            

        result_t recordFile(const char *file, timeout_t duration, timeout_t silence = 0);

        result_t speak(const char *format, ...);

        result_t playTone(const char *name, timeout_t duration = 0, unsigned level = 0);
        result_t playSingleTone(short f1, timeout_t duration, unsigned level = 0);
        result_t playDualTone(short f1, short f2, timeout_t duration, unsigned level = 0);

        result_t recordOffset(const char *file, const char *offset, timeout_t duration, timeout_t silence = 0);                                                                            

        result_t eraseFile(const char *file);

        result_t moveFile(const char *file1, const char *file2);

        result_t clearInput(void);

        bool waitInput(timeout_t timeout);
                                           
        result_t readInput(char *buffer, unsigned size, timeout_t timeout);

        char readKey(timeout_t timeout);

        result_t sizeSym(const char *id, unsigned size);
        result_t addSym(const char *id, const char *value);
        result_t setSym(const char *id, const char *value);
        result_t getSym(const char *id, char *buf, unsigned size);

        void postSym(const char *id, const char *value);
};       

class __EXPORT BayonneTSession : public BayonneSession
{
protected:
        friend class __EXPORT BayonneSysexec;

        void sysPost(const char *sid, char *id, const char *value);
        void sysVar(const char *tsid, char *id, const char *value, int size);
        void sysHeader(const char *tsid);
        void sysArgs(const char *tsid);
        void sysStatus(const char *tsid);  
        void sysRecord(const char *tsid, char *token);
        void sysReplay(const char *tsid, char *token);
        void sysFlush(const char *tsid);
        void sysWait(const char *tsid, char *token);
        void sysTone(const char *tsid, char *token);
        void sysSTone(const char *tsid, char *token);
        void sysDTone(const char *tsid, char *token);
        void sysPrompt(const char *tsid, const char *voice, const char *text);
        void sysInput(const char *tsid, char *token);
        void sysHangup(const char *tsid);
        void sysExit(const char *tsid, char *token);
        void sysError(const char *tsid, char *token);
        void sysReturn(const char *tsid, const char *text);
        void sysXfer(const char *tsid, const char *dest);
};

class __EXPORT BayonneSysexec : protected Thread, protected Bayonne
{
private:
        static bool exiting;
#ifndef WIN32
        static int iopair[2];
#endif
        static BayonneSysexec *libexec;

        static void readline(char *buf, unsigned max);

        void run(void);

        BayonneSysexec();
        ~BayonneSysexec();

public:
        static bool create(BayonneSession *s);
        static void allocate(const char *path, size_t bs = 0, int pri = 0, const char *modpath = NULL);
        static void cleanup(void);
        static void startup(void);
};

}; // namespace

#endif