serchan.h

Go to the documentation of this file.

/*
 * serchan.h
 *
 * Asynchronous Serial I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 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.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 24177 $
 * $Author: rjongbloed $
 * $Date: 2010-04-05 21:52:04 +1000 (Mon, 05 Apr 2010) $
 */

#ifndef PTLIB_SERIALCHANNEL_H
#define PTLIB_SERIALCHANNEL_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


class PConfig;


// Serial Channel

class PSerialChannel : public PChannel
{
  PCLASSINFO(PSerialChannel, PChannel);

  public:

    PSerialChannel();

    enum Parity {
      DefaultParity,    
      NoParity,         
      EvenParity,       
      OddParity,        
      MarkParity,       
      SpaceParity       
    };

    enum FlowControl {
      DefaultFlowControl,
      NoFlowControl,    
      XonXoff,         
      RtsCts           
    };

    PSerialChannel(
      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

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

    ~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  
    );
#endif // P_CONFIG_FILE

    static PStringList GetPortNames();


    PBoolean SetSpeed(
      DWORD speed   
    );

    DWORD GetSpeed() const;

    PBoolean SetDataBits(
      BYTE data   
    );

    BYTE GetDataBits() const;

    PBoolean SetParity(
      Parity parity   
    );

    Parity GetParity() const;

    PBoolean SetStopBits(
      BYTE stop   
    );

    BYTE GetStopBits() const;

    PBoolean SetInputFlowControl(
      FlowControl flowControl   
    );

    FlowControl GetInputFlowControl() const;

    PBoolean SetOutputFlowControl(
      FlowControl flowControl   
    );

    FlowControl GetOutputFlowControl() const;

#if P_CONFIG_FILE

    virtual void SaveSettings(
      PConfig & cfg   
    );
#endif // P_CONFIG_FILE



    void SetDTR(
      PBoolean state = true   
    );

    void ClearDTR();

    void SetRTS(
      PBoolean state = true   
    );

    void ClearRTS();

    void SetBreak(
      PBoolean state = true   
    );

    void ClearBreak();

    PBoolean GetCTS();

    PBoolean GetDSR();

    PBoolean GetDCD();

    PBoolean GetRing();


  private:
    void Construct();
    // Platform dependent construct of the serial channel.


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/serchan.h"
#else
#include "unix/ptlib/serchan.h"
#endif
};


#endif // PTLIB_SERIALCHANNEL_H


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