开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 通讯/手机编程 > 传真(Fax)编程 > 查看源码
FaxClient.h
资源名称：hylafax-5.3.0.tar.gz　[点击查看]
上传用户：weiyuanprp
上传日期：2020-05-20
资源大小：1169k
文件大小：13k
源码类别：

传真(Fax)编程

开发平台：

C/C++

FaxClient.h：源码内容
  1. /* $Id: FaxClient.h,v 1.10 2009/09/29 10:56:42 faxguy Exp $ */
  2. /*
  3.  * Copyright (c) 1990-1996 Sam Leffler
  4.  * Copyright (c) 1991-1996 Silicon Graphics, Inc.
  5.  * HylaFAX is a trademark of Silicon Graphics
  6.  *
  7.  * Permission to use, copy, modify, distribute, and sell this software and 
  8.  * its documentation for any purpose is hereby granted without fee, provided
  9.  * that (i) the above copyright notices and this permission notice appear in
  10.  * all copies of the software and related documentation, and (ii) the names of
  11.  * Sam Leffler and Silicon Graphics may not be used in any advertising or
  12.  * publicity relating to the software without the specific, prior written
  13.  * permission of Sam Leffler and Silicon Graphics.
  14.  * 
  15.  * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
  16.  * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
  17.  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
  18.  * 
  19.  * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  20.  * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  21.  * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  22.  * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
  23.  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
  24.  * OF THIS SOFTWARE.
  25.  */
  26. #ifndef _FaxClient_
  27. #define _FaxClient_
  29. #include "Types.h"
  30. #include "Str.h"
  31. #include "FaxConfig.h"
  33. class Transport;
  35. class FaxClient : public FaxConfig {
  36. public:
  37.     enum { // command reply codes
  38.         PRELIM   = 1, // positive preliminary
  39.         COMPLETE  = 2, // positive completion
  40.         CONTINUE  = 3, // positive intermediate
  41.         TRANSIENT = 4, // transient negative completion
  42.         ERROR   = 5 // permanent negative completion
  43.     };
  44.     enum { // data transfer TYPEs
  45.         TYPE_A = 1, // ASCII
  46.         TYPE_E = 2, // EBCDIC
  47.         TYPE_I = 3, // image
  48.         TYPE_L = 4 // local byte size
  49.     };
  50.     enum { // data transfer file STRUctures
  51.         STRU_F = 1, // file (no record structure)
  52.         STRU_R = 2, // record structure
  53.         STRU_P = 3, // page structure
  54.         STRU_T = 4 // multi-IFD TIFF
  55.     };
  56.     enum { // data transfer MODEs
  57.         MODE_S = 1, // stream
  58.         MODE_B = 2, // block
  59.         MODE_C = 3, // run-length compressed
  60.         MODE_Z = 4 // zlib compressed
  61.     };
  62.     enum { // data file FORMats
  63.         FORM_UNKNOWN = 0, // unknown, initial setting
  64.         FORM_PS   = 1, // PostScript Level I
  65.         FORM_PS2  = 2, // PostScript Level II
  66.         FORM_TIFF = 3, // TIFF
  67.         FORM_PCL  = 4, // HP PCL5
  68.         FORM_PDF  = 5 // Portable Document Format
  69.     };
  70.     enum {
  71.         TZ_GMT   = 1, // use GMT timezone for time values
  72.         TZ_LOCAL  = 2 // use local timezone for time values
  73.     };
  75.     // NB: the F_ prefixes workaround a bug in the AIX xlC compiler
  76.     struct F_stringtag {
  77.         const char*  name;
  78.         fxStr FaxClient::* p;
  79.         const char*  def; // NULL is shorthand for ""
  80.     };
  81.     struct F_numbertag {
  82.         const char*  name;
  83.         u_int FaxClient::*p;
  84.         u_int  def;
  85.     };
  86.     struct FaxParam {
  87.         const char* cmd;
  88.         const char** parmNames;
  89.         u_int NparmNames;
  90.         u_int FaxClient::*pv;
  91.     };
  92.     struct FaxFmtHeader {
  93.         char fmt; // format character used by server
  94.         const char* title; // column title to use
  95.     };
  96. private:
  97.     Transport* transport; // underlying transport protocol support
  98.     fxStr host; // server's host
  99.     fxStr modem; // server's modem
  100.     u_int state; // state flags
  101. #define FS_VERBOSE 0x0001 // print data as sent or received
  102. #define FS_LOGGEDIN 0x0002 // logged in on server
  103. #define FS_TZPEND 0x0004 // tzone setting pending
  104. #define FS_JFMTPEND 0x0008 // job status format string pending
  105. #define FS_RFMTPEND 0x0010 // job status format string pending
  106. #define FS_MFMTPEND 0x0020 // modem status format string pending
  107. #define FS_FFMTPEND 0x0040 // file status format string pending
  108.     fxStr userName; // sender's account name
  109.     fxStr senderName; // sender's full name (if available)
  110.     FILE* fdIn; // control stream input handle
  111.     FILE* fdOut; // control stream output handle
  112.     int fdData; // data transfer connection
  113.     char buf[1024]; // input buffer
  114.     int code; // code from last server repsonse
  115.     bool pasv; // use of passive mode
  116.     fxStr proto; // protocol to use for service query
  117.     fxStr lastResponse; // text message from last server response
  118.     fxStr lastContinuation; // continuation message from last server response
  119.     u_int port; // server port to connect to
  120.     u_int type; // data transfer type
  121.     u_int stru; // file structure
  122.     u_int mode; // data transfer mode
  123.     u_int format; // document format
  124.     u_int tzone; // use GMT or local timezone for time values
  125.     fxStr curjob; // current job's ID
  126.     fxStr jobFmt; // job status format string
  127.     fxStr recvFmt; // recv queue status format string
  128.     fxStr modemFmt; // modem status format string
  129.     fxStr fileFmt; // file status format string
  131.     static F_stringtag strings[];
  132.     static F_numbertag numbers[];
  133.     static FaxParam typeParam;
  134.     static FaxParam modeParam;
  135.     static FaxParam struParam;
  136.     static FaxParam formParam;
  137.     static FaxParam tzoneParam;
  139.     void init(void);
  141.     bool sendRawData(void* buf, int cc, fxStr& emsg);
  142.     bool setCommon(FaxParam&, u_int);
  143. protected:
  144.     FaxClient();
  145.     FaxClient(const fxStr& hostarg);
  146.     FaxClient(const char* hostarg);
  147.     ~FaxClient();
  149.     virtual void vprintError(const char* fmt, va_list ap);
  150.     virtual void vprintWarning(const char* fmt, va_list ap);
  151.     virtual void vtraceServer(const char* fmt, va_list ap);
  153.     void initServerState(void);
  154.     bool jobOp(const char* op, const char* jobid);
  155.     bool extract(u_int& pos, const char* pattern, fxStr& result,
  156.         const char* cmd, fxStr& emsg);
  157.     bool storeUnique(const char* cmd, fxStr& docname, fxStr& emsg);
  159.     const fxStr& getStatusFormat(u_int flag, const char* cmd, fxStr& fmt);
  160.     bool setStatusFormat(const char* cmd, u_int flag, fxStr&, const char*);
  161.     void makeHeader(const char* fmt, const FaxFmtHeader fmts[], fxStr& header);
  163.     virtual bool setupUserIdentity(fxStr& emsg);
  164.     void setupHostModem(const char*);
  165.     void setupHostModem(const fxStr&);
  167.     virtual void resetConfig(void);
  168.     virtual void setupConfig(void);
  169.     virtual bool setConfigItem(const char* tag, const char* value);
  170.     virtual void configError(const char* fmt ...);
  171.     virtual void configTrace(const char* fmt ...);
  173.     void unexpectedResponse(fxStr& emsg);
  174.     void protocolBotch(fxStr& emsg, const char* fmt ...);
  175.     virtual void lostServer(void);
  176. public:
  177.     void printError(const char* fmt ...);
  178.     void printWarning(const char* fmt ...);
  179.     void traceServer(const char* fmt ...);
  181.     // bookkeeping
  182.     void setHost(const fxStr&);
  183.     void setHost(const char*);
  184.     void setPort(int);
  185.     void setProtoName(const char*);
  186.     const fxStr& getHost() const;
  187.     void setModem(const fxStr&);
  188.     void setModem(const char*);
  189.     const fxStr& getModem(void) const;
  191.     virtual bool callServer(fxStr& emsg);
  192.     virtual bool hangupServer(void);
  193.     bool isConnected(void) const;
  194.     bool isPassive(void) const;
  195.     bool login(const char* user, const char* pass, fxStr& emsg);
  196.     bool admin(const char* pass, fxStr& emsg);
  197.     virtual const char* getPasswd(const char* prompt);
  198.     bool isLoggedIn(void) const;
  199.     void setCtrlFds(int in, int out);
  200.     FILE* getCtrlFd(void) const;
  202.     virtual bool initDataConn(fxStr& emsg);
  203.     virtual bool openDataConn(fxStr& emsg);
  204.     virtual void closeDataConn(void);
  205.     virtual bool abortDataConn(fxStr& emsg);
  206.     void setDataFd(int fd);
  207.     int getDataFd(void) const;
  209.     void setVerbose(bool);
  210.     bool getVerbose(void) const;
  212.     int getPort(void) const;
  213.     const fxStr& getProtoName(void) const;
  215.     const fxStr& getSenderName(void) const;
  216.     const fxStr& getUserName(void) const;
  218.     // output
  219.     int command(const char* fmt ...);
  220.     int vcommand(const char* fmt, va_list ap1, va_list ap2);
  221.     int getReply(bool expectEOF);
  222.     const fxStr& getLastResponse(void) const;
  223.     const fxStr& getLastContinuation(void) const;
  224.     int getLastCode(void) const;
  225.     /*
  226.      * Job control support.
  227.      */
  228.     const fxStr& getCurrentJob(void) const;
  229.     bool setCurrentJob(const char* jobid);
  230.     bool newJob(fxStr& jobid, fxStr& groupid, fxStr& emsg);
  231.     bool jobSubmit(const char* jobid);
  232.     bool jobSuspend(const char* jobid);
  233.     bool jobKill(const char* jobid);
  234.     bool jobDelete(const char* jobid);
  235.     bool jobWait(const char* jobid);
  236.     /*
  237.      * Set various job parameters.
  238.      */
  239.     bool jobParm(const char* name, const fxStr& value);
  240.     bool jobParm(const char* name, const char* value);
  241.     bool jobParm(const char* name, bool b);
  242.     bool jobParm(const char* name, u_int v);
  243.     bool jobParm(const char* name, float v);
  244.     bool jobSendTime(const struct tm tm);
  245.     bool jobLastTime(u_long);
  246.     bool jobRetryTime(u_long);
  247.     bool jobCover(const char* docname);
  248.     bool jobDocument(const char* docname);
  249.     bool jobPollRequest(const char* sep, const char* pwd);
  250.     /*
  251.      * Job group control support.
  252.      */
  253.     bool jgrpSubmit(const char* jgrpid);
  254.     bool jgrpSuspend(const char* jgrpid);
  255.     bool jgrpKill(const char* jgrpid);
  256.     bool jgrpWait(const char* jgrpid);
  257.     /*
  258.      * Query/set transfer state parameters.
  259.      */
  260.     u_int getType(void) const;
  261.     bool setType(u_int);
  262.     u_int getMode(void) const;
  263.     bool setMode(u_int);
  264.     u_int getStruct(void) const;
  265.     bool setStruct(u_int);
  266.     u_int getFormat(void) const;
  267.     bool setFormat(u_int);
  268.     u_int getTimeZone(void) const;
  269.     bool setTimeZone(u_int);
  270.     /*
  271.      * Send documents to the server.
  272.      */
  273.     bool storeUnique(fxStr& docname, fxStr& emsg); // STOU
  274.     bool storeTemp(fxStr& docname, fxStr& emsg); // STOT
  275.     bool storeFile(fxStr&, fxStr& emsg); // STOR
  276.     bool sendData(int fd, bool (FaxClient::*store)(fxStr&, fxStr&),
  277. fxStr& docname, fxStr& emsg);
  278.     bool sendZData(int fd, bool (FaxClient::*store)(fxStr&, fxStr&),
  279. fxStr& docname, fxStr& emsg);
  280.     /*
  281.      * Retrieve information from the server.
  282.      */
  283.     bool recvData(bool (*f)(void*, const char*, int, fxStr&),
  284.     void* arg, fxStr& emsg, u_long restart, const char* fmt, ...);
  285.     bool recvZData(bool (*f)(void*, const char*, int, fxStr&),
  286.     void* arg, fxStr& emsg, u_long restart, const char* fmt, ...);
  287.     /*
  288.      * Job scripting support.
  289.      */
  290.     bool runScript(const char* filename, fxStr& emsg);
  291.     bool runScript(FILE*, const char* filename, fxStr& emsg);
  292.     bool runScript(const char* script, u_long scriptLen,
  293.         const char* filename, fxStr& emsg);
  294.     /*
  295.      * Status query support.
  296.      */
  297.     static const FaxFmtHeader jobFormats[];
  298.     static const FaxFmtHeader recvFormats[];
  299.     static const FaxFmtHeader modemFormats[];
  300.     static const FaxFmtHeader fileFormats[];
  302.     bool setJobStatusFormat(const char*);
  303.     const fxStr& getJobStatusFormat(void);
  304.     bool setRecvStatusFormat(const char*);
  305.     const fxStr& getRecvStatusFormat(void);
  306.     bool setModemStatusFormat(const char*);
  307.     const fxStr& getModemStatusFormat(void);
  308.     bool setFileStatusFormat(const char*);
  309.     const fxStr& getFileStatusFormat(void);
  310.     void getJobStatusHeader(fxStr& header);
  311.     void getRecvStatusHeader(fxStr& header);
  312.     void getModemStatusHeader(fxStr& header);
  313.     void getFileStatusHeader(fxStr& header);
  314. };
  316. inline const fxStr& FaxClient::getSenderName(void) const{ return senderName; }
  317. inline const fxStr& FaxClient::getUserName(void) const { return userName; }
  318. inline const fxStr& FaxClient::getHost(void) const { return host; }
  319. inline const fxStr& FaxClient::getModem(void) const { return modem; }
  320. inline const fxStr& FaxClient::getProtoName() const { return proto; }
  321. inline bool FaxClient::getVerbose(void) const
  322.     { return (state&FS_VERBOSE) != 0; }
  323. inline int FaxClient::getPort(void) const { return port; }
  324. inline FILE* FaxClient::getCtrlFd(void) const { return fdOut; }
  325. inline int FaxClient::getDataFd(void) const { return fdData; }
  326. inline const fxStr& FaxClient::getLastResponse(void) const
  327.     { return lastResponse; }
  328. inline const fxStr& FaxClient::getLastContinuation(void) const
  329.     { return lastContinuation; }
  330. inline int FaxClient::getLastCode(void) const { return code; }
  331. inline bool FaxClient::isLoggedIn(void) const
  332.     { return (state&FS_LOGGEDIN) != 0; }
  333. inline bool FaxClient::isConnected(void) const { return fdIn != NULL; }
  334. inline bool FaxClient::isPassive(void) const { return pasv; }
  335. inline u_int FaxClient::getType(void) const { return type; }
  336. inline u_int FaxClient::getStruct(void) const { return stru; }
  337. inline u_int FaxClient::getMode(void) const { return mode; }
  338. inline u_int FaxClient::getFormat(void) const { return format; }
  339. inline u_int FaxClient::getTimeZone(void) const { return tzone; }
  340. inline const fxStr& FaxClient::getCurrentJob(void) const{ return curjob; }
  342. extern void fxFatal(const char* fmt, ...);
  343. #endif /* _FaxClient_ */