FileSink Class Reference

#include <files.h>

Inheritance diagram for FileSink:

List of all members.

---

Detailed Description

Definition at line 67 of file files.h.

Public Member Functions
	FileSink (std::ostream &out)
	FileSink (const char *filename, bool binary=true)
std::ostream *	GetStream ()
void	IsolatedInitialize (const NameValuePairs &parameters)
unsigned int	Put2 (const byte *inString, unsigned int length, int messageEnd, bool blocking)
	input multiple bytes for blocking or non-blocking processing
bool	IsolatedFlush (bool hardFlush, bool blocking)
BufferedTransformation &	Ref ()
	return a reference to this object
virtual std::string	AlgorithmName () const
	returns name of this algorithm, not universally implemented yet
virtual Clonable *	Clone () const
	this is not implemented by most classes yet
bool	Wait (unsigned long milliseconds)
	wait on this object
Static Public Attributes
const std::string	NULL_CHANNEL
Protected Member Functions
unsigned int	TransferTo2 (BufferedTransformation &target, unsigned long &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true)
unsigned int	CopyRangeTo2 (BufferedTransformation &target, unsigned long &begin, unsigned long end=ULONG_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const
Static Protected Member Functions
int	DecrementPropagation (int propagation)

---

Member Function Documentation

unsigned int FileSink::Put2 (  const byte *  inString, unsigned int  length, int  messageEnd, bool  blocking )  [virtual]

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 182 of file files.cpp.

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 709 of file cryptlib.h.

virtual byte* BufferedTransformation::CreatePutSpace (  unsigned int &  size  )  [inline, 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. Definition at line 728 of file cryptlib.h.

virtual unsigned int BufferedTransformation::PutModifiable2 (  byte *  inString, unsigned int  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 FilterWithBufferedInput. Definition at line 746 of file cryptlib.h.

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. Definition at line 194 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation().

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. Definition at line 200 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation().

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 Definition at line 786 of file cryptlib.h.

unsigned long BufferedTransformation::MaxRetrievable (   )  const [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(). Definition at line 246 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::CopyTo().

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

start retrieving the next message Returns false if no more messages exist or this message is not completely retrieved. Definition at line 335 of file cryptlib.cpp. References BufferedTransformation::AnyMessages(), and BufferedTransformation::AttachedTransformation().

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 933 of file cryptlib.h. Referenced by BufferedTransformation::Attach().

bool Waitable::Wait (  unsigned long  milliseconds  )  [inherited]

wait on this object same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container Definition at line 321 of file wait.cpp. References Waitable::GetWaitObjects(), and WaitObjectContainer::Wait(). Referenced by NetworkSource::GeneralPump2(), and NetworkSink::TimedFlush().

---

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

• files.h
• files.cpp

---