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): ______________________________________.
 *
 * $Revision: 28501 $
 * $Author: rjongbloed $
 * $Date: 2012-10-06 00:07:55 +1000 (Sat, 06 Oct 2012) $
 */

#ifndef PTLIB_MODEM_H
#define PTLIB_MODEM_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib.h>

#include <ptlib/serchan.h>

#if P_SERIAL

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   
    );

#if P_CONFIG_FILE

    PModem(
      PConfig & cfg   
    );
#endif // P_CONFIG_FILE


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


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

#if P_CONFIG_FILE

    virtual PBoolean Open(
      PConfig & cfg   
    );

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


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

    PString GetInitString() const;

    PBoolean CanInitialise() const;

    PBoolean Initialise();

    void SetDeinitString(
      const PString & str   
    );

    PString GetDeinitString() const;

    PBoolean CanDeinitialise() const;

    PBoolean 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;

    PBoolean CanDial() const;

    PBoolean Dial(const PString & number);

    void SetHangUpString(
      const PString & str   
    );

    PString GetHangUpString() const;

    PBoolean CanHangUp() const;

    PBoolean HangUp();

    PBoolean CanSendUser() const;

    PBoolean SendUser(
      const PString & str   
    );

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

    PBoolean 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
};


#endif // P_SERIAL

#endif // PTLIB_MODEM_H


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