octopi Namespace Reference

Classes
class	entity_data_bin
	Stores a set of infotons grouped by the entity that owns them. More...
class	octopus_entity
	Provides a way of identifying users of an octopus object. More...
class	octopus_request_id
	Identifies requests made on an octopus by users. More...
class	octopus_request_id_set
	a collection of unique request ids. More...
class	infoton_id_pair
	implements a list of waiting infotons. More...
class	infoton_list
	a list of pending requests and who made them. More...
class	identity_infoton
	Encapsulates just the action of identifying an octopus user. More...
class	identity_tentacle
	Supports an early step in using octopus services: getting an identity. More...
class	infoton
	An infoton is an individual request parcel with accompanying information. More...
class	octopus
	Octopus is a design pattern for generalized request processing systems. More...
class	tentacle
	Manages a service within an octopus by processing certain infotons. More...
class	tentacle_helper
	provides prefab implementations for parts of the tentacle object. More...
class	unhandled_request
	Informs the caller that a request type was unknown to the server octopus. More...
class	unhandled_request_tentacle
class	encryption_infoton
	Encapsulates the chit-chat necessary to establish an encrypted connection. More...
class	encryption_tentacle
	Processes the encryption_infoton object for setting up an encrypted channel. More...
class	encryption_wrapper
	Wraps an encrypted infoton when the octopus is in an encrypted mode. More...
class	unwrapping_tentacle
	this simple tentacle just unpacks the encryption_wrapper infoton. More...
class	entity_registry
	Provides a security model for the octopus. More...
class	blank_entity_registry
	the blank_entity_registry can be used when security is not an issue. More...
class	file_transfer_infoton
	Base objects used by the file transfer tentacle to schedule transfers. More...
class	file_transfer_tentacle
	Manages the transferrence of directory trees from one place to another. More...
class	octenc_key_record
	Tracks the keys that have been assigned for a secure channel. More...
class	key_repository
class	login_tentacle
	Provides rudimentary login services. More...
class	recursive_file_copy
	Copies entire hierarchies in the file system from one place to another. More...
class	security_infoton
	Encapsulates security activities (login, logout, refresh). More...
class	simple_entity_registry
	Provides a basic implementation of an entity_registry for octopus. More...
Functions
bool	text_form_applier (const octopus_entity &formal(key), entity_basket &bask, void *data_link)
bool	scramble_applier (const octopus_entity &formal(key), entity_basket &bask, void *data_link)
bool	any_item_applier (const octopus_entity &formal(key), entity_basket &bask, void *data_link)
bool	cleaning_applier (const octopus_entity &key, entity_basket &bask, void *data_link)
	SAFE_STATIC_CONST (string_array, identity_infoton::identity_classifier,(1, identity_classifier_strings)) int identity_infoton
template<class contents >
basis::clonable *	cloner (const contents &this_obj)
	a templated method for cloning any infoton with a valid copy constructor.
template<class contents >
basis::outcome	reconstituter (const structures::string_array &classifier, basis::byte_array &packed_form, infoton &reformed, contents formal(junk))
	< reconstituter should work for most infotons to restore flattened infotons.
	SAFE_STATIC_CONST (string_array, encryption_infoton::encryption_classifier,(1,&encryption_class_constant)) int encryption_infoton
	SAFE_STATIC_CONST (string_array, encryption_wrapper::encryption_classifier,(1, wrap_encryption_classifier)) int encryption_wrapper
	SAFE_STATIC_CONST (string_array, file_transfer_infoton::file_transfer_classifier,(1,&file_transfer_constant)) int file_transfer_infoton
	SAFE_STATIC_CONST (string_array, security_infoton::security_classifier,(1, login_classifier)) int security_infoton
bool	text_form_applier (const astring &formal(key), recognized_entity &info, void *datalink)
Variables
const int	OCTOPUS_TABLE_BITS = 6
const astring	identity_classifier_strings [] = { "#octide" }
const abyte	FAST_PACK_VERSION = 0x14
const int	MAXIMUM_TRASH_SIZE = 128 * KILOBYTE
const int	OCTOPUS_CHECKING_INTERVAL = 4 * MINUTE_ms
const char *	initter [] = { "__Unhandled__", NIL }
const char *	encryption_class_constant = "#octcod"
const char *	wrap_encryption_classifier [] = { "#octrap" }
const char *	file_transfer_constant = "#ftran"
const int	FTT_CLEANING_INTERVAL = 30 * SECOND_ms
const int	TRANSFER_TIMEOUT = 10 * MINUTE_ms
const int	MAX_CHUNK_RFC_COPY_HIER = 1 * MEGABYTE
const astring	login_classifier [] = { "#octsec" }
const int	ENTITY_HASH_BITS = 8

Function Documentation

bool octopi::any_item_applier	(	const octopus_entity &	formalkey,
		entity_basket &	bask,
		void *	data_link
	)

Definition at line 253 of file entity_data_bin.cpp.

Referenced by octopi::entity_data_bin::acquire_for_any().

bool octopi::cleaning_applier	(	const octopus_entity &	key,
		entity_basket &	bask,
		void *	data_link
	)

Definition at line 400 of file entity_data_bin.cpp.

References FUNCDEF, and LOG.

Referenced by octopi::entity_data_bin::clean_out_deadwood().

template<class contents >

basis::clonable* octopi::cloner ( const contents & this_obj ) [inline]

a templated method for cloning any infoton with a valid copy constructor.

Definition at line 151 of file infoton.h.

template<class contents >

basis::outcome octopi::reconstituter	(	const structures::string_array &	classifier,
		basis::byte_array &	packed_form,
		infoton *&	reformed,
		contents *	formaljunk
	)			`[inline]`

< reconstituter should work for most infotons to restore flattened infotons.

< the infotons that can be used here just need valid default constructor and unpack methods. the "junk" parameter is needed to allow the template to be disambiguated on some compilers--it is unused and should just be NIL.

Definition at line 44 of file tentacle_helper.h.

References octopi::tentacle::GARBAGE, octopi::tentacle::OKAY, octopi::infoton::set_classifier(), and basis::WHACK().

Referenced by octopi::login_tentacle::reconstitute(), octopi::file_transfer_tentacle::reconstitute(), octopi::unwrapping_tentacle::reconstitute(), octopi::encryption_tentacle::reconstitute(), octopi::tentacle_helper< unhandled_request >::reconstitute(), and octopi::identity_tentacle::reconstitute().