modem.h

Go to the documentation of this file.

/*
 * modem.h
 *
 * AT command set modem on asynchonous port class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-2002 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: modem.h,v $
 * Revision 1.16  2005/11/30 12:47:37  csoutheren
 * Removed tabs, reformatted some code, and changed tags for Doxygen
 *
 * Revision 1.15  2004/11/11 07:34:50  csoutheren
 * Added #include <ptlib.h>
 *
 * Revision 1.14  2002/11/06 22:47:24  robertj
 * Fixed header comment (copyright etc)
 *
 * Revision 1.13  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.12  1999/03/09 08:01:46  robertj
 * Changed comments for doc++ support (more to come).
 *
 * Revision 1.11  1999/02/16 08:07:10  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.10  1998/12/02 03:51:39  robertj
 * Unix compatibility changes
 *
 * Revision 1.9  1998/09/23 06:20:53  robertj
 * Added open source copyright license.
 *
 * Revision 1.8  1995/06/17 11:12:46  robertj
 * Documentation update.
 *
 * Revision 1.7  1995/03/14 12:41:51  robertj
 * Updated documentation to use HTML codes.
 *
 * Revision 1.6  1995/01/06  10:31:02  robertj
 * Documentation.
 *
 * Revision 1.5  1994/08/23  11:32:52  robertj
 * Oops
 *
 * Revision 1.4  1994/08/22  00:46:48  robertj
 * Added pragma fro GNU C++ compiler.
 *
 * Revision 1.3  1994/08/21  23:43:02  robertj
 * Moved meta-string transmitter from PModem to PChannel.
 *
 * Revision 1.2  1994/07/25  03:32:29  robertj
 * Fixed bug in GCC with enums.
 *
 * Revision 1.1  1994/06/25  11:55:15  robertj
 * Initial revision
 *
 */


#define _PMODEM

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib.h>

#ifndef _PSERIALCHANNEL
#include <ptlib/serchan.h>
#endif


class PModem : public PSerialChannel
{
  PCLASSINFO(PModem, PSerialChannel)

  public:
    PModem();
    PModem(
      const PString & port,   
      DWORD speed = 0,        
      BYTE data = 0,          
      Parity parity = DefaultParity,  
      BYTE stop = 0,          
      FlowControl inputFlow = DefaultFlowControl,   
      FlowControl outputFlow = DefaultFlowControl   
    );

    PModem(
      PConfig & cfg   
    );


  // Overrides from class PChannel
    virtual BOOL Close();
    // Close the modem serial port channel.


  // Overrides from class PSerialChannel
    virtual BOOL Open(
      const PString & port,   
      DWORD speed = 0,        
      BYTE data = 0,          
      Parity parity = DefaultParity,  
      BYTE stop = 0,          
      FlowControl inputFlow = DefaultFlowControl,   
      FlowControl outputFlow = DefaultFlowControl   
    );

    virtual BOOL Open(
      PConfig & cfg   
    );

    virtual void SaveSettings(
      PConfig & cfg   
    );
    // Save the current modem serial port settings into the configuration file.


  // New member functions
    void SetInitString(
      const PString & str   
    );

    PString GetInitString() const;

    BOOL CanInitialise() const;

    BOOL Initialise();

    void SetDeinitString(
      const PString & str   
    );

    PString GetDeinitString() const;

    BOOL CanDeinitialise() const;

    BOOL Deinitialise();

    void SetPreDialString(
      const PString & str   
    );

    PString GetPreDialString() const;

    void SetPostDialString(
      const PString & str   
    );

    PString GetPostDialString() const;

    void SetBusyString(
      const PString & str   
    );

    PString GetBusyString() const;

    void SetNoCarrierString(
      const PString & str   
    );

    PString GetNoCarrierString() const;

    void SetConnectString(
      const PString & str   
    );

    PString GetConnectString() const;

    BOOL CanDial() const;

    BOOL Dial(const PString & number);

    void SetHangUpString(
      const PString & str   
    );

    PString GetHangUpString() const;

    BOOL CanHangUp() const;

    BOOL HangUp();

    BOOL CanSendUser() const;

    BOOL SendUser(
      const PString & str   
    );

    void Abort();
    // Abort the current meta-string command operation eg dial, hang up etc.

    BOOL CanRead() const;

    enum Status {
      Unopened,           
      Uninitialised,      
      Initialising,       
      Initialised,        
      InitialiseFailed,   
      Dialling,           
      DialFailed,         
      AwaitingResponse,   
      LineBusy,           
      NoCarrier,          
      Connected,          
      HangingUp,          
      HangUpFailed,       
      Deinitialising,     
      DeinitialiseFailed, 
      SendingUserCommand, 
      NumStatuses
    };
    // Modem object states.

    Status GetStatus() const;


  protected:
    // Member variables
    PString initCmd, deinitCmd, preDialCmd, postDialCmd,
            busyReply, noCarrierReply, connectReply, hangUpCmd;
      // Modem command meta-strings.

    Status status;
      // Current modem status
};


// End Of File ///////////////////////////////////////////////////////////////

---