All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
conchan.h
Go to the documentation of this file.
/*
* conchan.h
*
* Console 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: 24160 $
* $Author: rjongbloed $
* $Date: 2010-03-29 02:09:03 -0500 (Mon, 29 Mar 2010) $
*/
#ifndef PTLIB_CONSOLECHANNEL_H
#define PTLIB_CONSOLECHANNEL_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
// Console Channel
class PConsoleChannel : public PChannel
{
PCLASSINFO(PConsoleChannel, PChannel);
public:
enum ConsoleType {
StandardInput,
StandardOutput,
StandardError
};
PConsoleChannel();
PConsoleChannel(
ConsoleType type
);
virtual bool SetLocalEcho(
bool localEcho
);
virtual PBoolean Open(
ConsoleType type
);
// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/conchan.h"
#else
#include "unix/ptlib/conchan.h"
#endif
};
#endif // PTLIB_CONSOLECHANNEL_H
// End Of File ///////////////////////////////////////////////////////////////
PConsoleChannel::StandardOutput
Definition: conchan.h:53
PConsoleChannel::SetLocalEcho
virtual bool SetLocalEcho(bool localEcho)
Set local echo mode.
PConsoleChannel::StandardError
Definition: conchan.h:54
PConsoleChannel::ConsoleType
ConsoleType
Definition: conchan.h:51
PConsoleChannel::Open
virtual PBoolean Open(ConsoleType type)
Open a serial channal.
PConsoleChannel::StandardInput
Definition: conchan.h:52
PBoolean
BOOL PBoolean
Definition: object.h:102
PConsoleChannel
This class defines an I/O channel that communicates via a console.
Definition: conchan.h:46
PChannel
Abstract class defining I/O channel semantics.
Definition: channel.h:107
PConsoleChannel::PConsoleChannel
PConsoleChannel()
Create a new console channel object, leaving it unopen.