TypeHandler Class Reference

Derive your specific type handlers from this class, for use with the TypeChain utility. More...

#include <typehandler.hh>

Inheritance diagram for TypeHandler:

List of all members.

Public Member Functions

• TypeHandler (string name, string file_ext="?")

  Constructor.
  
  

• virtual ~TypeHandler ()

  Destructor.
  
  

• virtual void decode (std::string &data, TypeParams &params)

  Decode data with parameters params.
  
  

• void decode (std::string &data)

  Create empty params map and decode.
  
  

• virtual void encode (std::string &data, TypeParams &params)

  Encode data with parameters params.
  
  

• void encode (std::string &data)

  Create empty params map and encode.
  
  

Public Attributes

• string type_name

  Type/encoding identifier.
  
  

• string filename_extension

  A common filename extension for this type.
  
  

---

Detailed Description

Derive your specific type handlers from this class, for use with the TypeChain utility.

As is, it implements the "identity" encoding, as described in the typechain document ($CVSROOT/s3/doc/typechain.txt), and similiar to encodings mentioned in various RFCs.

Todo:

add methods that use streams.

See also:

TypeChain

Author:

Reed Hedges <reed@zerohour.net> September, 2001

Definition at line 54 of file typehandler.hh.

---

Constructor & Destructor Documentation

TypeHandler::TypeHandler (  string  name, string  file_ext = "?" )  [inline]

Constructor. Definition at line 64 of file typehandler.hh.

virtual TypeHandler::~TypeHandler (   )  [inline, virtual]

Destructor. Definition at line 67 of file typehandler.hh.

---

Member Function Documentation

void TypeHandler::decode (  std::string &  data  )  [inline]

Create empty params map and decode. Definition at line 74 of file typehandler.hh.

virtual void TypeHandler::decode (  std::string &  data, TypeParams &  params )  [inline, virtual]

Decode data with parameters params. This class implements the "identity" type, and does no decoding. Reimplemented in ExternalTypeHandler, TypeBase64, TypeWinInet, TypeDeflate, and TypeGZip. Definition at line 70 of file typehandler.hh. Referenced by decode().

void TypeHandler::encode (  std::string &  data  )  [inline]

Create empty params map and encode. Definition at line 84 of file typehandler.hh.

virtual void TypeHandler::encode (  std::string &  data, TypeParams &  params )  [inline, virtual]

Encode data with parameters params. This class implements the "identity" type, and does no encoding. Reimplemented in ExternalTypeHandler, TypeBase64, TypeDeflate, and TypeGZip. Definition at line 80 of file typehandler.hh. Referenced by encode().

---

Member Data Documentation

string TypeHandler::filename_extension

A common filename extension for this type. (Used by TypeChain::guessTypeFromFilename()) Definition at line 61 of file typehandler.hh. Referenced by TypeHandler().

string TypeHandler::type_name

Type/encoding identifier. Definition at line 58 of file typehandler.hh. Referenced by TypeChain::registerHandler(), and TypeHandler().

---

The documentation for this class was generated from the following file:

• vos/corelibs/typechain/typehandler.hh

---