tty_interface.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2001 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the conexus library.                             *
 *                                                                         *
 *   The conexus library is free software; you can redistribute it and/or  *
 *   modify it under the terms of the GNU General Public License           *
 *   version 3 as published by the Free Software Foundation.               *
 *                                                                         *
 *   The conexus library 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 software. If not see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#ifndef CONEXUSTTY_INTERFACE_H
#define CONEXUSTTY_INTERFACE_H

#include <conexus/pointer.h>
#include <conexus/enums.h>

#include <conexus/serial_interface.h>

#include <termios.h>
#include <unistd.h>

namespace Conexus
{

  class TTYInterface: public virtual SerialInterface
  {
    public:

      typedef ConexusPointer<TTYInterface> pointer;

      TTYInterface() { }

      virtual ~TTYInterface() { }

      virtual void drain() = 0;

      virtual void flush_input() = 0;

      virtual void flush_output() = 0;

      virtual void flush() = 0;

      virtual void suspend_output() = 0;

      virtual void restart_output() = 0;

      virtual void suspend_input() = 0;

      virtual void restart_input() = 0;

      virtual void set_input_speed( unsigned speed, SetOption option = SET_NOW ) = 0;

      virtual void set_output_speed( unsigned speed, SetOption option = SET_NOW ) = 0;

      virtual void set_speed( unsigned speed, SetOption option = SET_NOW ) = 0;

      virtual unsigned input_speed() = 0;

      virtual unsigned output_speed() = 0;

      virtual void set_parity( Parity parity, ParityError error = PARITY_ERROR_IGNORE, SetOption option = SET_NOW ) = 0;

      virtual Parity parity() = 0;

      virtual ParityError parity_error() = 0;

      virtual unsigned byte_size() = 0;

      virtual void set_byte_size( unsigned size, SetOption option = SET_NOW ) = 0;

      virtual unsigned stop_bits() = 0;

      virtual void set_stop_bits( unsigned size, SetOption option = SET_NOW ) = 0;

      virtual FlowControl flow_control() = 0;

      virtual void set_flow_control( FlowControl flowcontrol, SetOption option = SET_NOW ) = 0;

      virtual bool is_carrier_detect_enabled() = 0;

      virtual void enable_carrier_detect( bool enable = true, SetOption option = SET_NOW ) = 0;

      virtual bool is_receiver_enabled() = 0;

      virtual void enable_receiver( bool enable = true, SetOption option = SET_NOW ) = 0;

      virtual void open() = 0;

      virtual void open( const std::string& name, ReadWrite mode = READ_WRITE_UNCHANGED ) = 0;

      virtual void close( bool force = false ) = 0;

      virtual void inject( const std::string& buffer ) = 0;

      virtual bool is_reset_on_close_enabled() = 0;

      virtual void enable_reset_on_close( bool reset = true ) = 0;

      virtual sigc::signal<void>& signal_input_speed_changed() = 0;
      virtual sigc::signal<void>& signal_output_speed_changed() = 0;
      virtual sigc::signal<void>& signal_parity_changed() = 0;
      virtual sigc::signal<void>& signal_byte_size_changed() = 0;
      virtual sigc::signal<void>& signal_stop_bits_changed() = 0;
      virtual sigc::signal<void>& signal_flow_control_changed() = 0;
      virtual sigc::signal<void>& signal_carrier_detect_changed() = 0;
      virtual sigc::signal<void>& signal_receiver_changed() = 0;

  };

}

#endif