TCLChannel.h

/*
    This software is Copyright by the Board of Trustees of Michigan
    State University (c) Copyright 2014.

    You may use this software under the terms of the GNU public license
    (GPL).  The terms of this license are described at:

     http://www.gnu.org/licenses/gpl.txt

     Authors:
             Ron Fox
             Jeromy Tompkins 
         NSCL
         Michigan State University
         East Lansing, MI 48824-1321
*/

#ifndef TCL_CHANNEL_H
#define TCL_CHANNEL_H

// Headers:

#include <tcl.h>

#ifndef TCLINTERPRETEROBJECT_H
#include <TCLInterpreterObject.h>
#endif

#include <string>

class CTCLChannel : public CTCLInterpreterObject
{
  // Member data:

private:
  Tcl_Channel   m_Channel;
  bool          m_fCloseOnDestroy;
  bool          m_fRegistered;


  // Constructors and Destructor.

public:

  CTCLChannel(CTCLInterpreter* pInterp, 
          std::string      Filename,
          const char*      pMode,
          int              permissions) ; 
  CTCLChannel(CTCLInterpreter* pInterp,
          int              argc,
          const char**           pargv,
          int              flags); 
  CTCLChannel(CTCLInterpreter* pInterp,
          int              port,
          std::string      host) ; 
  CTCLChannel(CTCLInterpreter* pInterp,
          int              port,
          Tcl_TcpAcceptProc* proc,
          ClientData       AppData) ;     
  CTCLChannel(CTCLInterpreter* pInterp,
          Tcl_Channel      Channel);     
  CTCLChannel(const CTCLChannel& rhs);   
  virtual ~CTCLChannel();

  // Canonical operations (assignment and (in)equality comparison.


private:
  CTCLChannel& operator=(const CTCLChannel& rhs); 

  int operator==(const CTCLChannel& rhs) const;     
  int operator!=(const CTCLChannel& rhs) const;     
public:
  // Selectors:

public:
  Tcl_Channel getChannel() const {
    return m_Channel;
  }
  bool ClosesOnDestroy() const {
    return m_fCloseOnDestroy;
  }
  // Mutators:

protected:
  void setChannel(Tcl_Channel Channel) {
    m_Channel = Channel;
  }
  void CloseOnDestroy(bool state) {
    m_fCloseOnDestroy = state;
  }

  // Operations on a channel:

public:
  int Read( void** pData, int nChars); 
  int Write(const void* pData, int nBytes); 

  bool atEof();         
  void Flush();         
  void Close();         
  void Register();  
  void SetEncoding(std::string Name);
  std::string GetEncoding();
};
#endif