csp::StandardChannelFactory< DATA_TYPE > Class Template Reference

Inheritance diagram for csp::StandardChannelFactory< DATA_TYPE >:

List of all members.

---

Detailed Description

template<typename DATA_TYPE>
class csp::StandardChannelFactory< DATA_TYPE >

An implementation of ChannelFactory for standard (unbuffered, non-networked) channels.

See also:

ChannelFactory

Public Member Functions
void	any2Any (Chanin< DATA_TYPE > *in, Chanout< DATA_TYPE > *out, bool canPoisonIn=true, bool canPoisonOut=true)
	Gets an any-to-any channel from the factory.
virtual std::pair< Chanin< DATA_TYPE >, Chanout< DATA_TYPE > >	any2AnyPair (bool canPoisonIn=true, bool canPoisonOut=true)
	Gets an any-to-any channel from the factory.
void	any2One (AltChanin< DATA_TYPE > *in, Chanout< DATA_TYPE > *out, bool canPoisonIn=true, bool canPoisonOut=true)
	Gets an any-to-one channel from the factory.
virtual std::pair< AltChanin< DATA_TYPE >, Chanout< DATA_TYPE > >	any2OnePair (bool canPoisonIn=true, bool canPoisonOut=true)
	Gets an any-to-one channel from the factory.
void	one2Any (Chanin< DATA_TYPE > *in, Chanout< DATA_TYPE > *out, bool canPoisonIn=true, bool canPoisonOut=true)
	Gets a one-to-any channel from the factory.
virtual std::pair< Chanin< DATA_TYPE >, Chanout< DATA_TYPE > >	one2AnyPair (bool canPoisonIn=true, bool canPoisonOut=true)
	Gets a one-to-any channel from the factory.
void	one2One (AltChanin< DATA_TYPE > *in, Chanout< DATA_TYPE > *out, bool canPoisonIn=true, bool canPoisonOut=true)
	Gets a one-to-one channel from the factory.
virtual std::pair< AltChanin< DATA_TYPE >, Chanout< DATA_TYPE > >	one2OnePair (bool canPoisonIn=true, bool canPoisonOut=true)
	Gets a one-to-one channel from the factory.

---

Member Function Documentation

template<typename DATA_TYPE>

void csp::StandardChannelFactory< DATA_TYPE >::one2One	(	AltChanin< DATA_TYPE > *	in,
		Chanout< DATA_TYPE > *	out,
		bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual]

Gets a one-to-one channel from the factory.

Parameters:

	in	A pointer to an AltChanin object that will become the input end of the requested channel.
	out	A pointer to a Chanout object that will become the output end of the requested channel.
	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Implements csp::ChannelFactory< DATA_TYPE >.

template<typename DATA_TYPE>

void csp::StandardChannelFactory< DATA_TYPE >::one2Any	(	Chanin< DATA_TYPE > *	in,
		Chanout< DATA_TYPE > *	out,
		bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual]

Gets a one-to-any channel from the factory.

Parameters:

	in	A pointer to a Chanin object that will become the input end of the requested channel.
	out	A pointer to a Chanout object that will become the output end of the requested channel.
	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Implements csp::ChannelFactory< DATA_TYPE >.

template<typename DATA_TYPE>

void csp::StandardChannelFactory< DATA_TYPE >::any2One	(	AltChanin< DATA_TYPE > *	in,
		Chanout< DATA_TYPE > *	out,
		bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual]

Gets an any-to-one channel from the factory.

Parameters:

	in	A pointer to an AltChanin object that will become the input end of the requested channel.
	out	A pointer to a Chanout object that will become the output end of the requested channel.
	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Implements csp::ChannelFactory< DATA_TYPE >.

template<typename DATA_TYPE>

void csp::StandardChannelFactory< DATA_TYPE >::any2Any	(	Chanin< DATA_TYPE > *	in,
		Chanout< DATA_TYPE > *	out,
		bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual]

Gets an any-to-any channel from the factory.

Parameters:

	in	A pointer to a Chanin object that will become the input end of the requested channel.
	out	A pointer to a Chanout object that will become the output end of the requested channel.
	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Implements csp::ChannelFactory< DATA_TYPE >.

template<typename DATA_TYPE>

virtual std::pair< AltChanin<DATA_TYPE> , Chanout<DATA_TYPE> > csp::ChannelFactory< DATA_TYPE >::one2OnePair	(	bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual, inherited]

Gets a one-to-one channel from the factory.

Parameters:

	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Returns:

A pair comprising the input and output ends (respectively) of the channel

template<typename DATA_TYPE>

virtual std::pair< Chanin<DATA_TYPE> , Chanout<DATA_TYPE> > csp::ChannelFactory< DATA_TYPE >::one2AnyPair	(	bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual, inherited]

Gets a one-to-any channel from the factory.

Parameters:

	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Returns:

A pair comprising the input and output ends (respectively) of the channel

template<typename DATA_TYPE>

virtual std::pair< AltChanin<DATA_TYPE> , Chanout<DATA_TYPE> > csp::ChannelFactory< DATA_TYPE >::any2OnePair	(	bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual, inherited]

Gets an any-to-one channel from the factory.

Parameters:

	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Returns:

A pair comprising the input and output ends (respectively) of the channel

template<typename DATA_TYPE>

virtual std::pair< Chanin<DATA_TYPE> , Chanout<DATA_TYPE> > csp::ChannelFactory< DATA_TYPE >::any2AnyPair	(	bool	canPoisonIn = true,
		bool	canPoisonOut = true
	)			[inline, virtual, inherited]

Gets an any-to-any channel from the factory.

Parameters:

	canPoisonIn	Flag to designate whether the input end should be poisonable
	canPoisonOut	Flag to designate whether the output end should be poisonable

Returns:

A pair comprising the input and output ends (respectively) of the channel

---