tentacle_helper< contents > Class Template Reference

provides prefab implementations for parts of the tentacle object. More...

#include <tentacle_helper.h>

Inheritance diagram for tentacle_helper< contents >:

[legend]Collaboration diagram for tentacle_helper< contents >:

[legend]List of all members.

Public Member Functions
	tentacle_helper (const string_array &classifier, bool backgrounded, int motivational_rate=tentacle::DEFAULT_RATE)
virtual	~tentacle_helper ()
	force a virtual destructor.
virtual outcome	reconstitute (const string_array &classifier, byte_array &packed_form, infoton *&reformed)
	this is a simple enough action that it is totally automated.
virtual outcome	consume (infoton &formal(to_chow), const octopus_request_id &formal(item_id), byte_array &transformed)
	consume is not really provided here. remember to implement for servers!
virtual void	expunge (const octopus_entity &formal(to_remove))
	no general actions for expunge; they are all class-specific.

---

Detailed Description

template<class contents>
class tentacle_helper< contents >

provides prefab implementations for parts of the tentacle object.

tentacle_helper provides the base functionality of reconstitution that should support most of the simple needs of a user of an octopus. if the octopus will actually implement the request processing (instead of just unpacking returned responses), the consume method needs to be filled in appropriately so that it implements the derived tentacle's purpose.

Definition at line 62 of file tentacle_helper.h.

---

Constructor & Destructor Documentation

template<class contents>

tentacle_helper< contents >::tentacle_helper	(	const string_array &	classifier,
		bool	backgrounded,
		int	motivational_rate = tentacle::DEFAULT_RATE
	)			[inline]

Definition at line 65 of file tentacle_helper.h.

template<class contents>

virtual tentacle_helper< contents >::~tentacle_helper

(

)

[inline, virtual]

force a virtual destructor.

Definition at line 69 of file tentacle_helper.h.

---

Member Function Documentation

template<class contents>

virtual outcome tentacle_helper< contents >::reconstitute	(	const string_array &	classifier,
		byte_array &	packed_form,
		infoton *&	reformed
	)			[inline, virtual]

this is a simple enough action that it is totally automated.

Implements tentacle.

Reimplemented in identity_tentacle, encryption_tentacle, unwrapping_tentacle, file_transfer_tentacle, and login_tentacle.

Definition at line 73 of file tentacle_helper.h.

template<class contents>

virtual outcome tentacle_helper< contents >::consume	(	infoton &	formal(to_chow),
		const octopus_request_id &	formal(item_id),
		byte_array &	transformed
	)			[inline, virtual]

consume is not really provided here. remember to implement for servers!

consume will generally need to be implemented by a "real" tentacle that is based on the tentacle_helper. in the context of network communications, the server side will generally have a real tentacle that implements consume() while the client side will just have the tentacle_helper version of one, which does nothing.

Definition at line 85 of file tentacle_helper.h.

template<class contents>

virtual void tentacle_helper< contents >::expunge

(

const octopus_entity &

formal(to_remove)

)

[inline, virtual]

no general actions for expunge; they are all class-specific.

Definition at line 89 of file tentacle_helper.h.

---

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

• /home/fred/hoople/source/lib_src/library/octopus/tentacle_helper.h

---