Route input to different and/or multiple channels based on channel ID. More...

#include <channels.h>

Inheritance diagram for ChannelSwitch:

Collaboration diagram for ChannelSwitch:

Public Member Functions
	ChannelSwitch ()

	ChannelSwitch (BufferedTransformation &destination)

	ChannelSwitch (BufferedTransformation &destination, const std::string &outChannel)

void	IsolatedInitialize (const NameValuePairs &parameters=g_nullNameValuePairs)
	Initialize or reinitialize this object, without signal propagation. More...

size_t	ChannelPut2 (const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing on a channel. More...

size_t	ChannelPutModifiable2 (const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee on a channel. More...

bool	ChannelFlush (const std::string &channel, bool completeFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output on a channel. More...

bool	ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Marks the end of a series of messages on a channel. More...

byte *	ChannelCreatePutSpace (const std::string &channel, size_t &size)
	Request space which can be written into by the caller. More...

void	AddDefaultRoute (BufferedTransformation &destination)

void	RemoveDefaultRoute (BufferedTransformation &destination)

void	AddDefaultRoute (BufferedTransformation &destination, const std::string &outChannel)

void	RemoveDefaultRoute (BufferedTransformation &destination, const std::string &outChannel)

void	AddRoute (const std::string &inChannel, BufferedTransformation &destination, const std::string &outChannel)

void	RemoveRoute (const std::string &inChannel, BufferedTransformation &destination, const std::string &outChannel)

Public Member Functions inherited from Multichannel< Sink >
bool	Flush (bool hardFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output, with signal propagation. More...

bool	MessageSeriesEnd (int propagation=-1, bool blocking=true)
	Marks the end of a series of messages, with signal propagation. More...

byte *	CreatePutSpace (size_t &size)
	Request space which can be written into by the caller. More...

size_t	Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing. More...

size_t	PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee. More...

byte *	ChannelCreatePutSpace (const std::string &channel, size_t &size)

bool	ChannelPutModifiable (const std::string &channel, byte *inString, size_t length)

size_t	ChannelPutModifiable2 (const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)

SIGNALS
Public Member Functions inherited from Sink
size_t	TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer bytes from this object to another BufferedTransformation. More...

size_t	CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
	Copy bytes from this object to another BufferedTransformation. More...

Public Member Functions inherited from BufferedTransformation
virtual	~BufferedTransformation ()

	BufferedTransformation ()
	Construct a BufferedTransformation. More...

BufferedTransformation &	Ref ()
	Provides a reference to this object. More...

size_t	Put (byte inByte, bool blocking=true)
	Input a byte for processing. More...

size_t	Put (const byte *inString, size_t length, bool blocking=true)
	Input a byte buffer for processing. More...

size_t	PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 16-bit word for processing. More...

size_t	PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 32-bit word for processing. More...

virtual bool	CanModifyInput () const
	Determines whether input can be modified by the callee. More...

size_t	PutModifiable (byte *inString, size_t length, bool blocking=true)
	Input multiple bytes that may be modified by callee. More...

bool	MessageEnd (int propagation=-1, bool blocking=true)
	Signals the end of messages to the object. More...

size_t	PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true)
	Input multiple bytes for processing and signal the end of a message. More...

unsigned int	GetMaxWaitObjectCount () const
	Retrieves the maximum number of waitable objects. More...

void	GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
	Retrieves waitable objects. More...

virtual bool	IsolatedMessageSeriesEnd (bool blocking)
	Marks the end of a series of messages, without signal propagation. More...

virtual void	Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
	Initialize or reinitialize this object, with signal propagation. More...

virtual void	SetAutoSignalPropagation (int propagation)
	Set propagation of automatically generated and transferred signals. More...

virtual int	GetAutoSignalPropagation () const
	Retrieve automatic signal propagation value. More...

virtual lword	MaxRetrievable () const
	Provides the number of bytes ready for retrieval. More...

virtual bool	AnyRetrievable () const
	Determines whether bytes are ready for retrieval. More...

virtual size_t	Get (byte &outByte)
	Retrieve a 8-bit byte. More...

virtual size_t	Get (byte *outString, size_t getMax)
	Retrieve a block of bytes. More...

virtual size_t	Peek (byte &outByte) const
	Peek a 8-bit byte. More...

virtual size_t	Peek (byte *outString, size_t peekMax) const
	Peek a block of bytes. More...

size_t	GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 16-bit word. More...

size_t	GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 32-bit word. More...

size_t	PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 16-bit word. More...

size_t	PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 32-bit word. More...

lword	TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL)
	move transferMax bytes of the buffered output to target as input More...

virtual lword	Skip (lword skipMax=LWORD_MAX)
	Discard skipMax bytes from the output buffer. More...

lword	CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	copy copyMax bytes of the buffered output to target as input More...

lword	CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy bytes from this object using an index to another BufferedTransformation. More...

virtual lword	TotalBytesRetrievable () const
	Provides the number of bytes ready for retrieval. More...

virtual unsigned int	NumberOfMessages () const
	Provides the number of meesages processed by this object. More...

virtual bool	AnyMessages () const
	Determines if any messages are available for retrieval. More...

virtual bool	GetNextMessage ()
	Start retrieving the next message. More...

virtual unsigned int	SkipMessages (unsigned int count=UINT_MAX)
	Skip a number of meessages. More...

unsigned int	TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
	Transfer messages from this object to another BufferedTransformation. More...

unsigned int	CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy messages from this object to another BufferedTransformation. More...

virtual void	SkipAll ()
	Skip all messages in the series. More...

void	TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
	Transfer all bytes from this object to another BufferedTransformation. More...

void	CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
	Copy messages from this object to another BufferedTransformation. More...

virtual bool	GetNextMessageSeries ()
	Retrieve the next message in a series. More...

virtual unsigned int	NumberOfMessagesInThisSeries () const
	Provides the number of messages in a series. More...

virtual unsigned int	NumberOfMessageSeries () const
	Provides the number of messages in a series. More...

size_t	TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer messages from this object to another BufferedTransformation. More...

size_t	TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer all bytes from this object to another BufferedTransformation. More...

size_t	ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
	Input a byte for processing on a channel. More...

size_t	ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true)
	Input a byte buffer for processing on a channel. More...

size_t	ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true)
	Input multiple bytes that may be modified by callee on a channel. More...

size_t	ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 16-bit word for processing on a channel. More...

size_t	ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 32-bit word for processing on a channel. More...

bool	ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Signal the end of a message. More...

size_t	ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true)
	Input multiple bytes for processing and signal the end of a message. More...

virtual void	SetRetrievalChannel (const std::string &channel)
	Sets the default retrieval channel. More...

virtual bool	Attachable ()
	Determines whether the object allows attachment. More...

virtual BufferedTransformation *	AttachedTransformation ()
	Returns the object immediately attached to this object. More...

virtual const BufferedTransformation *	AttachedTransformation () const
	Returns the object immediately attached to this object. More...

virtual void	Detach (BufferedTransformation *newAttachment=0)
	Delete the current attachment chain and attach a new one. More...

virtual void	Attach (BufferedTransformation *newAttachment)
	Add newAttachment to the end of attachment chain. More...

Public Member Functions inherited from Algorithm
virtual	~Algorithm ()

	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()

virtual Clonable *	Clone () const
	Copies this object. More...

Public Member Functions inherited from Waitable
virtual	~Waitable ()

bool	Wait (unsigned long milliseconds, CallStack const &callStack)
	Wait on this object. More...

Private Attributes
RouteMap	m_routeMap

DefaultRouteList	m_defaultRoutes

ChannelRouteIterator	m_it

bool	m_blocked

Friends
class	ChannelRouteIterator

Additional Inherited Members
Public Types inherited from ChannelSwitchTypedefs
typedef std::pair< BufferedTransformation *, std::string >	Route

typedef std::multimap< std::string, Route >	RouteMap

typedef std::pair< BufferedTransformation *, value_ptr< std::string > >	DefaultRoute

typedef std::list< DefaultRoute >	DefaultRouteList

typedef RouteMap::iterator	MapIterator

typedef DefaultRouteList::iterator	ListIterator

Static Public Attributes inherited from BufferedTransformation
static const std::string &	NULL_CHANNEL = DEFAULT_CHANNEL

Static Protected Member Functions inherited from BufferedTransformation
static int	DecrementPropagation (int propagation)
	Decrements the propagation count while clamping at 0. More...

Detailed Description

Route input to different and/or multiple channels based on channel ID.

Definition at line 92 of file channels.h.

Constructor & Destructor Documentation

ChannelSwitch::ChannelSwitch ( )

inline

Definition at line 95 of file channels.h.

ChannelSwitch::ChannelSwitch ( BufferedTransformation & destination )

inline

Definition at line 96 of file channels.h.

ChannelSwitch::ChannelSwitch	(	BufferedTransformation &	destination,
		const std::string &	outChannel
	)

inline

Definition at line 100 of file channels.h.

Member Function Documentation

void ChannelSwitch::AddDefaultRoute ( BufferedTransformation & destination )

Definition at line 262 of file channels.cpp.

Here is the caller graph for this function:

void ChannelSwitch::AddDefaultRoute	(	BufferedTransformation &	destination,
		const std::string &	outChannel
	)

Definition at line 277 of file channels.cpp.

void ChannelSwitch::AddRoute	(	const std::string &	inChannel,
		BufferedTransformation &	destination,
		const std::string &	outChannel
	)

Definition at line 292 of file channels.cpp.

Here is the caller graph for this function:

byte * ChannelSwitch::ChannelCreatePutSpace	(	const std::string &	channel,
		size_t &	size
	)

virtual

Request space which can be written into by the caller.

Parameters

channel	the channel to process the data
size	the requested size of the buffer

Returns: a pointer to a memroy block with length size

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

size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.

The base class implementation sets size to 0 and returns NULL.

Note: Some objects, like ArraySink(), cannot create a space because its fixed. In the case of an ArraySink(), the pointer to the array is returned and the size is remaining size.

Reimplemented from BufferedTransformation.

Definition at line 230 of file channels.cpp.

Here is the call graph for this function:

bool ChannelSwitch::ChannelFlush	(	const std::string &	channel,
		bool	hardFlush,
		int	propagation = `-1`,
		bool	blocking = `true`
	)

virtual

Flush buffered input and/or output on a channel.

Parameters

channel	the channel to flush the data
hardFlush	is used to indicate whether all data should be flushed
propagation	the number of attached transformations the ChannelFlush() signal should be passed
blocking	specifies whether the object should block when processing input

Returns: true of the Flush was successful

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Implements Multichannel< Sink >.

Definition at line 179 of file channels.cpp.

bool ChannelSwitch::ChannelMessageSeriesEnd	(	const std::string &	channel,
		int	propagation = `-1`,
		bool	blocking = `true`
	)

virtual

Marks the end of a series of messages on a channel.

Parameters

channel	the channel to signal the end of a series of messages
propagation	the number of attached transformations the ChannelMessageSeriesEnd() signal should be passed
blocking	specifies whether the object should block when processing input

Each object that receives the signal will perform its processing, decrement propagation, and then pass the signal on to attached transformations if the value is not 0.

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Note: There should be a MessageEnd() immediately before MessageSeriesEnd().

Reimplemented from BufferedTransformation.

Definition at line 204 of file channels.cpp.

size_t ChannelSwitch::ChannelPut2	(	const std::string &	channel,
		const byte *	inString,
		size_t	length,
		int	messageEnd,
		bool	blocking
	)

virtual

Input multiple bytes for processing on a channel.

Parameters

channel	the channel to process the data.
inString	the byte buffer to process.
length	the size of the string, in bytes.
messageEnd	means how many filters to signal MessageEnd() to, including this one.
blocking	specifies whether the object should block when processing input.

Returns: the number of bytes that remain in the block (i.e., bytes not processed)

Implements Multichannel< Sink >.

Definition at line 146 of file channels.cpp.

size_t ChannelSwitch::ChannelPutModifiable2	(	const std::string &	channel,
		byte *	inString,
		size_t	length,
		int	messageEnd,
		bool	blocking
	)

virtual

Input multiple bytes that may be modified by callee on a channel.

Parameters

channel	the channel to process the data
inString	the byte buffer to process
length	the size of the string, in bytes
messageEnd	means how many filters to signal MessageEnd() to, including this one
blocking	specifies whether the object should block when processing input

Returns: the number of bytes that remain in the block (i.e., bytes not processed)

Reimplemented from BufferedTransformation.

Definition at line 245 of file channels.cpp.

Here is the call graph for this function:

void ChannelSwitch::IsolatedInitialize ( const NameValuePairs & parameters = g_nullNameValuePairs )

virtual

Initialize or reinitialize this object, without signal propagation.

Parameters

parameters a set of NameValuePairs to initialize this object

Exceptions

NotImplemented

IsolatedInitialize() is used to initialize or reinitialize an object using a variable number of arbitrarily typed arguments. The function avoids the need for multiple constructors providing all possible combintations of configurable parameters.

IsolatedInitialize() does not call Initialize() on attached transformations. If initialization should be propagated, then use the Initialize() function.

If a derived class does not override IsolatedInitialize(), then the base class throws NotImplemented.

Reimplemented from BufferedTransformation.

Definition at line 171 of file channels.cpp.

void ChannelSwitch::RemoveDefaultRoute ( BufferedTransformation & destination )

Definition at line 267 of file channels.cpp.

void ChannelSwitch::RemoveDefaultRoute	(	BufferedTransformation &	destination,
		const std::string &	outChannel
	)

Definition at line 282 of file channels.cpp.

void ChannelSwitch::RemoveRoute	(	const std::string &	inChannel,
		BufferedTransformation &	destination,
		const std::string &	outChannel
	)

Definition at line 297 of file channels.cpp.

Friends And Related Function Documentation

friend class ChannelRouteIterator

friend

Definition at line 129 of file channels.h.

Member Data Documentation

bool ChannelSwitch::m_blocked

private

Definition at line 127 of file channels.h.

DefaultRouteList ChannelSwitch::m_defaultRoutes

private

Definition at line 124 of file channels.h.

ChannelRouteIterator ChannelSwitch::m_it

private

Definition at line 126 of file channels.h.

RouteMap ChannelSwitch::m_routeMap

private

Definition at line 123 of file channels.h.

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

src/cryptopp/channels.h
src/cryptopp/channels.cpp

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation