DERSetEncoder Class Reference

#include <asn.h>

Inheritance diagram for DERSetEncoder:

DERGeneralEncoder ByteQueue Bufferless< BufferedTransformation > BufferedTransformation Algorithm Waitable Clonable List of all members.

Detailed Description

DER Set Encoder.

Definition at line 207 of file asn.h.

Public Member Functions

 DERSetEncoder (BufferedTransformation &outQueue, byte asnTag=SET|CONSTRUCTED)
 DERSetEncoder (DERSetEncoder &outQueue, byte asnTag=SET|CONSTRUCTED)
void MessageEnd ()
lword MaxRetrievable () const
 returns number of bytes that is currently ready for retrieval
bool AnyRetrievable () const
 returns whether any bytes are currently ready for retrieval
void IsolatedInitialize (const NameValuePairs &parameters)
byte * CreatePutSpace (size_t &size)
 request space which can be written into by the caller, and then used as input to Put()
size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
 input multiple bytes for blocking or non-blocking processing
size_t Get (byte &outByte)
 try to retrieve a single byte
size_t Get (byte *outString, size_t getMax)
 try to retrieve multiple bytes
size_t Peek (byte &outByte) const
 peek at the next byte without removing it from the output buffer
size_t Peek (byte *outString, size_t peekMax) const
 peek at multiple bytes without removing them from the output buffer
size_t TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true)
 upon return, byteCount contains number of bytes that have finished being transfered, and returns the number of bytes left in the current transfer block
size_t CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const
 upon return, begin contains the start position of data yet to be finished copying, and returns the number of bytes left in the current transfer block
void SetNodeSize (size_t nodeSize)
lword CurrentSize () const
bool IsEmpty () const
void Clear ()
void Unget (byte inByte)
void Unget (const byte *inString, size_t length)
const byte * Spy (size_t &contiguousSize) const
void LazyPut (const byte *inString, size_t size)
void LazyPutModifiable (byte *inString, size_t size)
void UndoLazyPut (size_t size)
void FinalizeLazyPut ()
bool operator== (const ByteQueue &rhs) const
byte operator[] (lword i) const
void swap (ByteQueue &rhs)
bool IsolatedFlush (bool hardFlush, bool blocking)
BufferedTransformationRef ()
 return a reference to this object
virtual std::string AlgorithmName () const
 returns name of this algorithm, not universally implemented yet
virtual ClonableClone () const
 this is not implemented by most classes yet
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 wait on this object
WAITING
unsigned int GetMaxWaitObjectCount () const
 maximum number of wait objects that this object can return
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 put wait objects into container

Static Public Attributes

static const std::string NULL_CHANNEL

Static Protected Member Functions

static int DecrementPropagation (int propagation)

Friends

class Walker


Member Function Documentation

lword ByteQueue::MaxRetrievable (  )  const [inline, virtual, inherited]

returns number of bytes that is currently ready for retrieval

All retrieval functions return the actual number of bytes retrieved, which is the lesser of the request number and MaxRetrievable().

Reimplemented from BufferedTransformation.

Definition at line 23 of file queue.h.

byte * ByteQueue::CreatePutSpace ( size_t &  size  )  [virtual, inherited]

request space which can be written into by the caller, and then used as input to Put()

Note:
The purpose of this method is to help avoid doing extra memory allocations.

Reimplemented from BufferedTransformation.

Definition at line 410 of file queue.cpp.

References ByteQueueNode::buf, ByteQueue::FinalizeLazyPut(), ByteQueueNode::m_tail, ByteQueueNode::MaxSize(), and ByteQueueNode::next.

size_t ByteQueue::Put2 ( const byte *  inString,
size_t  length,
int  messageEnd,
bool  blocking 
) [virtual, inherited]

input multiple bytes for blocking or non-blocking processing

Parameters:
messageEnd means how many filters to signal MessageEnd to, including this one

Implements BufferedTransformation.

Definition at line 216 of file queue.cpp.

References ByteQueue::FinalizeLazyPut(), ByteQueueNode::next, and ByteQueueNode::Put().

BufferedTransformation& BufferedTransformation::Ref (  )  [inline, inherited]

return a reference to this object

This function is useful for passing a temporary BufferedTransformation object to a function that takes a non-const reference.

Definition at line 736 of file cryptlib.h.

virtual size_t BufferedTransformation::PutModifiable2 ( byte *  inString,
size_t  length,
int  messageEnd,
bool  blocking 
) [inline, virtual, inherited]

input multiple bytes that may be modified by callee for blocking or non-blocking processing

Parameters:
messageEnd means how many filters to signal MessageEnd to, including this one

Reimplemented in MeterFilter, FilterWithBufferedInput, OutputProxy, Multichannel< Filter >, and Multichannel< Sink >.

Definition at line 773 of file cryptlib.h.

Referenced by BufferedTransformation::ChannelPutModifiable2(), NetworkSource::DoPump(), and Filter::OutputModifiable().

void BufferedTransformation::GetWaitObjects ( WaitObjectContainer container,
CallStack const &  callStack 
) [virtual, inherited]

put wait objects into container

Parameters:
callStack is used for tracing no wait loops, example: something.GetWaitObjects(c, CallStack("my func after X", 0));
  • or in an outer GetWaitObjects() method that itself takes a callStack parameter: innerThing.GetWaitObjects(c, CallStack("MyClass::GetWaitObjects at X", &callStack));

Implements Waitable.

Reimplemented in Redirector, NetworkSource, and NetworkSink.

Definition at line 214 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetWaitObjects().

Referenced by NetworkSource::GetWaitObjects(), and BufferedTransformation::GetWaitObjects().

bool BufferedTransformation::Flush ( bool  hardFlush,
int  propagation = -1,
bool  blocking = true 
) [virtual, inherited]

flush buffered input and/or output

Parameters:
hardFlush is used to indicate whether all data should be flushed
Note:
Hard flushes must be used with care. It means try to process and output everything, even if there may not be enough data to complete the action. For example, hard flushing a HexDecoder would cause an error if you do it after inputing an odd number of hex encoded characters. For some types of filters, for example ZlibDecompressor, hard flushes can only be done at "synchronization points". These synchronization points are positions in the data stream that are created by hard flushes on the corresponding reverse filters, in this example ZlibCompressor. This is useful when zlib compressed data is moved across a network in packets and compression state is preserved across packets, as in the ssh2 protocol.

Reimplemented in Filter, Redirector, OutputProxy, SecretSharing, InformationDispersal, Unflushable< Filter >, Unflushable< Sink >, Unflushable< Multichannel< Filter > >, Multichannel< Filter >, and Multichannel< Sink >.

Definition at line 227 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation().

Referenced by BufferedTransformation::ChannelFlush().

bool BufferedTransformation::MessageSeriesEnd ( int  propagation = -1,
bool  blocking = true 
) [virtual, inherited]

mark end of a series of messages

There should be a MessageEnd immediately before MessageSeriesEnd.

Reimplemented in Filter, Redirector, OutputProxy, Multichannel< Filter >, and Multichannel< Sink >.

Definition at line 233 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::IsolatedMessageSeriesEnd().

Referenced by EqualityComparisonFilter::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelMessageSeriesEnd(), and EncodedObjectFilter::Put().

virtual void BufferedTransformation::SetAutoSignalPropagation ( int  propagation  )  [inline, virtual, inherited]

set propagation of automatically generated and transferred signals

propagation == 0 means do not automaticly generate signals

Reimplemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, SourceTemplate< StringStore >, AutoSignaling< BufferedTransformation >, AutoSignaling< InputRejecting< BufferedTransformation > >, AutoSignaling< Filter >, AutoSignaling< Source >, and AutoSignaling< Unflushable< Multichannel< Filter > > >.

Definition at line 813 of file cryptlib.h.

bool BufferedTransformation::GetNextMessage (  )  [virtual, inherited]

start retrieving the next message

Returns false if no more messages exist or this message is not completely retrieved.

Reimplemented in MessageQueue, and Store.

Definition at line 368 of file cryptlib.cpp.

References BufferedTransformation::AnyMessages(), BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetNextMessage().

Referenced by BufferedTransformation::GetNextMessage(), and BufferedTransformation::TransferMessagesTo2().

virtual bool BufferedTransformation::Attachable (  )  [inline, virtual, inherited]

returns whether this object allows attachment

Some BufferedTransformation objects (e.g. Filter objects) allow other BufferedTransformation objects to be attached. When this is done, the first object instead of buffering its output, sents that output to the attached object as input. The entire attachment chain is deleted when the anchor object is destructed.

Reimplemented in Filter.

Definition at line 963 of file cryptlib.h.

Referenced by BufferedTransformation::Attach().

bool Waitable::Wait ( unsigned long  milliseconds,
CallStack const &  callStack 
) [inherited]

wait on this object

same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container

Definition at line 388 of file wait.cpp.

References Waitable::GetWaitObjects(), and WaitObjectContainer::Wait().

Referenced by NetworkSink::DoFlush(), and NetworkSource::DoPump().


The documentation for this class was generated from the following file:
Generated on Fri Feb 6 00:56:29 2009 for Crypto++ by  doxygen 1.4.7