inetprot.h

Go to the documentation of this file.

/*
 * inetprot.h
 *
 * Internet Protocol ancestor channel 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: 26195 $
 * $Author: csoutheren $
 * $Date: 2011-07-13 18:06:48 +1000 (Wed, 13 Jul 2011) $
 */

#ifndef PTLIB_INETPROT_H
#define PTLIB_INETPROT_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <ptclib/mime.h>


class PSocket;
class PIPSocket;


class PInternetProtocol : public PIndirectChannel
{
  PCLASSINFO(PInternetProtocol, PIndirectChannel)

  protected:
    PInternetProtocol(
      const char * defaultServiceName, 
      PINDEX cmdCount,                 
      char const * const * cmdNames    
    );
    // Create an unopened TCP/IP protocol socket channel.


  public:
  // Overrides from class PChannel.
    virtual PBoolean Read(
      void * buf,   
      PINDEX len    
    );

    virtual int ReadChar();

    virtual PBoolean Write(
      const void * buf, 
      PINDEX len        
    );

     void SetReadLineTimeout(
       const PTimeInterval & t
     );

  // New functions for class.
    virtual PBoolean Connect(
      const PString & address,    
      WORD port = 0               
    );
    virtual PBoolean Connect(
      const PString & address,    
      const PString & service     
    );

    virtual PBoolean Accept(
      PSocket & listener    
    );

    const PString & GetDefaultService() const;

    PIPSocket * GetSocket() const;

    virtual PBoolean WriteLine(
      const PString & line 
    );

    virtual PBoolean ReadLine(
      PString & line,             
      PBoolean allowContinuation = false  
    );

    virtual void UnRead(
      int ch                
    );
    virtual void UnRead(
      const PString & str   
    );
    virtual void UnRead(
      const void * buffer,  
      PINDEX len            
    );

    virtual bool WriteCommand(
      PINDEX cmdNumber,                         
      const PString & param = PString::Empty()  
    );
    virtual bool WriteCommand(
      PINDEX cmdNumber,                         
      const PString & param,                    
      const PMIMEInfo & mime                    
    );

    virtual PBoolean ReadCommand(
      PINDEX & num,     
      PString & args  
    );
    virtual PBoolean ReadCommand(
      PINDEX & num,     
      PString & args,   
      PMIMEInfo & mime  
    );

    virtual PBoolean WriteResponse(
      unsigned numericCode, 
      const PString & info  
    );
    virtual PBoolean WriteResponse(
      const PString & code, 
      const PString & info  
    );

    virtual PBoolean ReadResponse();
    virtual PBoolean ReadResponse(
      int & code,      
      PString & info   
    );
    virtual PBoolean ReadResponse(
      int & code,      
      PString & info,  
      PMIMEInfo & mime 
    );

    virtual int ExecuteCommand(
      PINDEX cmdNumber       
    );
    virtual int ExecuteCommand(
      PINDEX cmdNumber,      
      const PString & param  
    );

    int GetLastResponseCode() const;

    PString GetLastResponseInfo() const;


  protected:
    virtual PINDEX ParseResponse(
      const PString & line 
    );


    PString defaultServiceName;
    // Default Service name to use for the internet protocol socket.

    PStringArray commandNames;
    // Names of each of the command codes.

    PCharArray unReadBuffer;
    // Buffer for characters put back into the data stream.

    PINDEX unReadCount;
    // Buffer count for characters put back into the data stream.

    PTimeInterval readLineTimeout;
    // Time for characters in a line to be received.

    enum StuffState {
      DontStuff, StuffIdle, StuffCR, StuffCRLF, StuffCRLFdot, StuffCRLFdotCR
    } stuffingState;
    // Do byte stuffing of '.' characters in output to the socket channel.

    PBoolean newLineToCRLF;
    // Translate \\n characters to CR/LF pairs.

    int     lastResponseCode;
    PString lastResponseInfo;
    // Responses

  private:
    PBoolean AttachSocket(PIPSocket * socket);
};



#endif // PTLIB_INETPROT_H


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