WvStreams
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
WvFunctorEncoder< IT, OT, FT > Class Template Reference

Functor specifies the functor type which must have an operator() with a signature compatible with invocations of the form: const IT data = ...; OT result = func(data);. More...

#include <wvfunctorencoder.h>

Inheritance diagram for WvFunctorEncoder< IT, OT, FT >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef FT FType
typedef IT IType
typedef OT OType
typedef WvBufBase< IType > IBuffer
typedef WvBufBase< OType > OBuffer
typedef WvBufViewBase< IType > IBufferView
typedef WvBufViewBase< OType > OBufferView

Public Member Functions

 WvFunctorEncoder (const FType &f)
bool encode (IBuffer &inbuf, OBuffer &outbuf, bool flush=false, bool finish=false)
 Typed variant of encode().
bool encode (WvBuf &inbuf, WvBuf &outbuf, bool flush=false, bool finish=false)
 Reads data from the input buffer, encodes it, and writes the result to the output buffer.
bool flush (IBuffer &inbuf, OBuffer &outbuf, bool finish=false)
 Typed variant of flush().
bool flush (WvBuf &inbuf, WvBuf &outbuf, bool finish=false)
 Flushes the encoder and optionally finishes it.
bool finish (OBuffer &outbuf)
 Typed variant of finish().
bool finish (WvBuf &outbuf)
 Tells the encoder that NO MORE DATA will ever be encoded.
bool isok () const
 Returns true if the encoder has not encountered an error.
bool isfinished () const
 Returns true if the encoder can no longer encode data.
WvString geterror () const
 Returns an error message if any is available.
bool reset ()
 Asks an encoder to reset itself to its initial state at creation time, if supported.
bool flushstrbuf (WvStringParm instr, WvBuf &outbuf, bool finish=false)
 Flushes data through the encoder from a string to a buffer.
bool flushstrstr (WvStringParm instr, WvString &outstr, bool finish=false)
 Flushes data through the encoder from a string to a string.
bool encodebufstr (WvBuf &inbuf, WvString &outstr, bool flush=false, bool finish=false)
 Encodes data from a buffer to a string.
bool flushbufstr (WvBuf &inbuf, WvString &outstr, bool finish=false)
 Flushes data through the encoder from a buffer to a string.
WvString strflushstr (WvStringParm instr, bool finish=false)
 Flushes data through the encoder from a string to a string.
WvString strflushbuf (WvBuf &inbuf, bool finish=false)
 Flushes data through the encoder from a buffer to a string.
bool flushmembuf (const void *inmem, size_t inlen, WvBuf &outbuf, bool finish=false)
 Flushes data through the encoder from memory to a buffer.
bool flushmemmem (const void *inmem, size_t inlen, void *outmem, size_t *outlen, bool finish=false)
 Flushes data through the encoder from memory to memory.
bool encodebufmem (WvBuf &inbuf, void *outmem, size_t *outlen, bool flush=false, bool finish=false)
 Encodes data from a buffer to memory.
bool flushbufmem (WvBuf &inbuf, void *outmem, size_t *outlen, bool finish=false)
 Flushes data through the encoder from a buffer to memory.
bool flushstrmem (WvStringParm instr, void *outmem, size_t *outlen, bool finish=false)
 Flushes data through the encoder from a string to memory.
WvString strflushmem (const void *inmem, size_t inlen, bool finish=false)
 Flushes data through the encoder from memory to a string.

Protected Member Functions

virtual bool _typedencode (IBuffer &inbuf, OBuffer &outbuf, bool flush)
 Typed variant of _encode().
virtual bool _reset ()
 Template method implementation of reset().
virtual bool _typedfinish (OBuffer &outbuf)
 Typed variant of _finish().
virtual bool _encode (WvBuf &inbuf, WvBuf &outbuf, bool flush)
 Wrapper implementation of _encode().
virtual bool _finish (WvBuf &outbuf)
 Wrapper implementation of _finish().
void setnotok ()
 Sets 'okay' to false explicitly.
void seterror (WvStringParm message)
 Sets an error condition, then setnotok().
void seterror (WVSTRING_FORMAT_DECL)
 Sets an error condition, then setnotok().
void setfinished ()
 Sets 'finished' to true explicitly.
virtual bool _isok () const
 Template method implementation of isok().
virtual bool _isfinished () const
 Template method implementation of isfinished().
virtual WvString _geterror () const
 Template method implementation of geterror().

Protected Attributes

FT f
bool okay
bool finished
WvString errstr

Detailed Description

template<class IT, class OT, class FT>
class WvFunctorEncoder< IT, OT, FT >

Functor specifies the functor type which must have an operator() with a signature compatible with invocations of the form: const IT data = ...; OT result = func(data);.

The best way to use this monster is to subclass with friendly names for the implementations that are needed. For maximum performance, define the functor as a struct that provides an operator() inline. This is extremely efficent since this class is templated, so there's room for lots of compiler optimization.

"IT" is the input buffer datatype "OT" is the output buffer datatype "FT" is the functor type

Definition at line 31 of file wvfunctorencoder.h.


Member Function Documentation

template<class IT , class OT , class FT >
virtual bool WvFunctorEncoder< IT, OT, FT >::_typedencode ( IBuffer inbuf,
OBuffer outbuf,
bool  flush 
) [inline, protected, virtual]
template<class IT , class OT , class FT >
virtual bool WvFunctorEncoder< IT, OT, FT >::_reset ( ) [inline, protected, virtual]

Template method implementation of reset().

When this method is invoked, the current local state will be okay == true and finished == false. If false is returned, then okay will be set to false.

May set a detailed error message if an error occurs.

Returns: true on success, false on error or if not supported

See also:
reset

Reimplemented from WvEncoder.

Definition at line 64 of file wvfunctorencoder.h.

bool WvTypedEncoder< IT, OT, WvEncoder >::encode ( IBuffer inbuf,
OBuffer outbuf,
bool  flush = false,
bool  finish = false 
) [inline, inherited]

Typed variant of encode().

See also:
encode(WvBuf&, WvBuf&, bool, bool)

Definition at line 47 of file wvtypedencoder.h.

References WvTypedEncoder< IT, OT, S >::encode(), WvTypedEncoder< IT, OT, S >::finish(), and WvTypedEncoder< IT, OT, S >::flush().

bool WvTypedEncoder< IT, OT, WvEncoder >::encode ( WvBuf inbuf,
WvBuf outbuf,
bool  flush = false,
bool  finish = false 
) [inline, inherited]

Reimplemented from WvEncoder.

Definition at line 76 of file wvtypedencoder.h.

bool WvTypedEncoder< IT, OT, WvEncoder >::flush ( IBuffer inbuf,
OBuffer outbuf,
bool  finish = false 
) [inline, inherited]

Typed variant of flush().

See also:
flush(WvBuf, WvBuf, bool)

Definition at line 59 of file wvtypedencoder.h.

References WvTypedEncoder< IT, OT, S >::finish(), and WvTypedEncoder< IT, OT, S >::flush().

Referenced by WvFunctorEncoder< IT, OT, FT >::_typedencode().

bool WvTypedEncoder< IT, OT, WvEncoder >::flush ( WvBuf inbuf,
WvBuf outbuf,
bool  finish = false 
) [inline, inherited]

Reimplemented from WvEncoder.

Definition at line 81 of file wvtypedencoder.h.

bool WvTypedEncoder< IT, OT, WvEncoder >::finish ( OBuffer outbuf) [inline, inherited]

Typed variant of finish().

See also:
finish(WvBuf)

Definition at line 70 of file wvtypedencoder.h.

References WvTypedEncoder< IT, OT, S >::finish().

bool WvTypedEncoder< IT, OT, WvEncoder >::finish ( WvBuf outbuf) [inline, inherited]

Reimplemented from WvEncoder.

Definition at line 86 of file wvtypedencoder.h.

virtual bool WvTypedEncoder< IT, OT, WvEncoder >::_typedfinish ( OBuffer outbuf) [inline, protected, virtual, inherited]

Typed variant of _finish().

See also:
_finish(WvBuf&)

Definition at line 103 of file wvtypedencoder.h.

virtual bool WvTypedEncoder< IT, OT, WvEncoder >::_encode ( WvBuf inbuf,
WvBuf outbuf,
bool  flush 
) [inline, protected, virtual, inherited]

Wrapper implementation of _encode().

Implements WvEncoder.

Definition at line 107 of file wvtypedencoder.h.

References WvTypedEncoder< IT, OT, S >::_typedencode().

virtual bool WvTypedEncoder< IT, OT, WvEncoder >::_finish ( WvBuf outbuf) [inline, protected, virtual, inherited]

Wrapper implementation of _finish().

Reimplemented from WvEncoder.

Definition at line 116 of file wvtypedencoder.h.

References WvTypedEncoder< IT, OT, S >::_typedfinish().

bool WvEncoder::isok ( ) const [inline, inherited]

Returns true if the encoder has not encountered an error.

This should only be used to record permanent failures. Transient errors (eg. bad block, but recoverable) should be detected in a different fashion.

Returns: true if the encoder is ok

Definition at line 90 of file wvencoder.h.

References WvEncoder::_isok(), and WvEncoder::okay.

Referenced by WvEncoder::geterror().

bool WvEncoder::isfinished ( ) const [inline, inherited]

Returns true if the encoder can no longer encode data.

This will be set when the encoder detects and end-of-data mark in its input, or when finish() is called.

Returns: true if the encoder is finished

Definition at line 101 of file wvencoder.h.

References WvEncoder::_isfinished(), and WvEncoder::finished.

WvString WvEncoder::geterror ( ) const [inherited]

Returns an error message if any is available.

Returns: the error message, or the null string is isok() == true

Definition at line 23 of file wvencoder.cc.

References WvEncoder::_geterror(), WvEncoder::errstr, and WvEncoder::isok().

bool WvEncoder::reset ( ) [inherited]

Asks an encoder to reset itself to its initial state at creation time, if supported.

This function may be called at any time, even if isok() == false, or isfinished() == true.

If the behaviour is not supported or an error occurs, then false is returned and afterwards isok() == false.

Returns: true on success

See also:
_reset for the actual implementation

Definition at line 60 of file wvencoder.cc.

References WvEncoder::_reset(), WvEncoder::errstr, WvEncoder::finished, WvEncoder::okay, and WvEncoder::seterror().

bool WvEncoder::flushstrbuf ( WvStringParm  instr,
WvBuf outbuf,
bool  finish = false 
) [inherited]

Flushes data through the encoder from a string to a buffer.

"instr" is the input string "outbuf" is the output buffer "finish" is if true, calls finish() on success Returns: true on success

Definition at line 77 of file wvencoder.cc.

References WvEncoder::encode().

bool WvEncoder::flushstrstr ( WvStringParm  instr,
WvString outstr,
bool  finish = false 
) [inherited]

Flushes data through the encoder from a string to a string.

The output data is appended to the target string.

"instr" is the input string "outstr" is the output string "finish" is if true, calls finish() on success Returns: true on success

Definition at line 86 of file wvencoder.cc.

References WvEncoder::encode(), and WvBufBase< unsigned char >::getstr().

Referenced by WvEncoder::strflushstr().

bool WvEncoder::encodebufstr ( WvBuf inbuf,
WvString outstr,
bool  flush = false,
bool  finish = false 
) [inherited]

Encodes data from a buffer to a string.

The output data is appended to the target string.

"inbuf" is the input buffer "outstr" is the output string "flush" is if true, flushes the encoder "finish" is if true, calls finish() on success Returns: true on success

Definition at line 97 of file wvencoder.cc.

References WvEncoder::encode(), and WvBufBase< unsigned char >::getstr().

Referenced by WvEncoder::flushbufstr().

bool WvEncoder::flushbufstr ( WvBuf inbuf,
WvString outstr,
bool  finish = false 
) [inline, inherited]

Flushes data through the encoder from a buffer to a string.

The output data is appended to the target string.

"inbuf" is the input buffer "outstr" is the output string "finish" is if true, calls finish() on success Returns: true on success

Definition at line 249 of file wvencoder.h.

References WvEncoder::encodebufstr(), and WvEncoder::finish().

Referenced by WvEncoder::strflushbuf().

WvString WvEncoder::strflushstr ( WvStringParm  instr,
bool  finish = false 
) [inherited]

Flushes data through the encoder from a string to a string.

"inbuf" is the input buffer "finish" is if true, calls finish() on success Returns: the resulting encoded string, does not signal errors

Definition at line 107 of file wvencoder.cc.

References WvEncoder::flushstrstr().

Referenced by WvDBusServerAuth::authorize().

WvString WvEncoder::strflushbuf ( WvBuf inbuf,
bool  finish = false 
) [inherited]

Flushes data through the encoder from a buffer to a string.

"inbuf" is the input buffer "finish" is if true, calls finish() on success Returns: the resulting encoded string, does not signal errors

Definition at line 115 of file wvencoder.cc.

References WvEncoder::flushbufstr().

Referenced by WvX509Mgr::sign(), and WvEncoder::strflushmem().

bool WvEncoder::flushmembuf ( const void *  inmem,
size_t  inlen,
WvBuf outbuf,
bool  finish = false 
) [inherited]

Flushes data through the encoder from memory to a buffer.

"inmem" is the input data pointer "inlen" is the input data length "outbuf" is the output buffer "finish" is if true, calls finish() on success Returns: true on success

Definition at line 123 of file wvencoder.cc.

References WvEncoder::encode().

bool WvEncoder::flushmemmem ( const void *  inmem,
size_t  inlen,
void *  outmem,
size_t *  outlen,
bool  finish = false 
) [inherited]

Flushes data through the encoder from memory to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"inmem" is the input data pointer "inlen" is the input data length "outmem" is the output data pointer "outlen" is the output data length, by reference "finish" is if true, calls finish() on success Returns: true on success

Definition at line 132 of file wvencoder.cc.

References WvEncoder::encodebufmem().

Referenced by unhexify().

bool WvEncoder::encodebufmem ( WvBuf inbuf,
void *  outmem,
size_t *  outlen,
bool  flush = false,
bool  finish = false 
) [inherited]

Encodes data from a buffer to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"inmem" is the input data pointer "inlen" is the input data length "outmem" is the output data pointer "outlen" is the output data length, by reference "flush" is if true, flushes the encoder "finish" is if true, calls finish() on success Returns: true on success

Definition at line 140 of file wvencoder.cc.

References WvEncoder::encode(), and WvBufBaseCommonImpl< T >::used().

Referenced by WvEncoder::flushbufmem(), and WvEncoder::flushmemmem().

bool WvEncoder::flushbufmem ( WvBuf inbuf,
void *  outmem,
size_t *  outlen,
bool  finish = false 
) [inline, inherited]

Flushes data through the encoder from a buffer to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"inbuf" is the input buffer "outmem" is the output data pointer "outlen" is the output data length, by reference "finish" is if true, calls finish() on success Returns: true on success

Definition at line 337 of file wvencoder.h.

References WvEncoder::encodebufmem(), and WvEncoder::finish().

Referenced by WvEncoder::flushstrmem().

bool WvEncoder::flushstrmem ( WvStringParm  instr,
void *  outmem,
size_t *  outlen,
bool  finish = false 
) [inherited]

Flushes data through the encoder from a string to memory.

The outlen parameter specifies by reference the length of the output buffer. It is updated in place to reflect the number of bytes copied to the output buffer. If the buffer was too small to hold the data, the overflow bytes will be discarded and false will be returned.

"instr" is the input string "outmem" is the output data pointer "outlen" is the output data length, by reference "finish" is if true, calls finish() on success Returns: true on success

Definition at line 150 of file wvencoder.cc.

References WvEncoder::flushbufmem().

Referenced by WvX509::verify().

WvString WvEncoder::strflushmem ( const void *  inmem,
size_t  inlen,
bool  finish = false 
) [inherited]

Flushes data through the encoder from memory to a string.

"inmem" is the input data pointer "inlen" is the input data length "finish" is if true, calls finish() on success Returns: the resulting encoded string, does not signal errors

Definition at line 158 of file wvencoder.cc.

References WvEncoder::strflushbuf().

void WvEncoder::setnotok ( ) [inline, protected, inherited]

Sets 'okay' to false explicitly.

Definition at line 371 of file wvencoder.h.

References WvEncoder::okay.

Referenced by WvEncoder::seterror().

void WvEncoder::seterror ( WvStringParm  message) [inline, protected, inherited]

Sets an error condition, then setnotok().

Definition at line 375 of file wvencoder.h.

References WvEncoder::errstr, and WvEncoder::setnotok().

Referenced by WvBase64Decoder::_encode(), WvHexDecoder::_encode(), and WvEncoder::reset().

void WvEncoder::seterror ( WVSTRING_FORMAT_DECL  ) [inline, protected, inherited]

Sets an error condition, then setnotok().

Definition at line 379 of file wvencoder.h.

References WvEncoder::seterror().

Referenced by WvEncoder::seterror().

void WvEncoder::setfinished ( ) [inline, protected, inherited]

Sets 'finished' to true explicitly.

Definition at line 383 of file wvencoder.h.

References WvEncoder::finished.

Referenced by WvBase64Decoder::_encode(), and WvEncoder::finish().

virtual bool WvEncoder::_isok ( ) const [inline, protected, virtual, inherited]

Template method implementation of isok().

Not called if any of the following cases are true:

  • okay == false

Most implementations do not need to override this.

Returns: true if the encoder is ok

See also:
setnotok

Reimplemented in WvEncoderChain.

Definition at line 400 of file wvencoder.h.

Referenced by WvEncoder::isok().

virtual bool WvEncoder::_isfinished ( ) const [inline, protected, virtual, inherited]

Template method implementation of isfinished().

Not called if any of the following cases are true:

  • finished == true

Most implementations do not need to override this.

Returns: true if the encoder is finished

See also:
setfinished

Reimplemented in WvEncoderChain.

Definition at line 416 of file wvencoder.h.

Referenced by WvEncoder::isfinished().

virtual WvString WvEncoder::_geterror ( ) const [inline, protected, virtual, inherited]

Template method implementation of geterror().

Not called if any of the following cases are true:

  • isok() == true
  • errstr is not null

Most implementations do not need to override this.

Returns: the error message, or the null string if _isok() == true

See also:
seterror

Reimplemented in WvEncoderChain.

Definition at line 433 of file wvencoder.h.

Referenced by WvEncoder::geterror().


Member Data Documentation

bool WvEncoder::okay [protected, inherited]
bool WvEncoder::finished [protected, inherited]
WvString WvEncoder::errstr [protected, inherited]

the error message

Definition at line 72 of file wvencoder.h.

Referenced by WvEncoder::geterror(), WvEncoder::reset(), and WvEncoder::seterror().


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